modify topk docs

This commit is contained in:
fengyihang 2023-01-17 15:43:40 +08:00
parent fb36b4b482
commit 268e552a6c
8 changed files with 12 additions and 12 deletions

View File

@ -342,7 +342,7 @@ Reduction函数
mindspore.ops.ne mindspore.ops.ne
mindspore.ops.not_equal mindspore.ops.not_equal
mindspore.ops.msort mindspore.ops.msort
mindspore.ops.top_k mindspore.ops.topk
线性代数函数 线性代数函数
^^^^^^^^^^^^^ ^^^^^^^^^^^^^

View File

@ -1,6 +0,0 @@
mindspore.Tensor.top_k
======================
.. py:method:: mindspore.Tensor.top_k(k, sorted=True)
详情请参考 :func:`mindspore.ops.top_k`

View File

@ -0,0 +1,6 @@
mindspore.Tensor.topk
======================
.. py:method:: mindspore.Tensor.topk(k, dim=None, largest=True, sorted=True)
详情请参考 :func:`mindspore.ops.topk`

View File

@ -279,7 +279,7 @@ mindspore.Tensor
mindspore.Tensor.to_coo mindspore.Tensor.to_coo
mindspore.Tensor.to_csr mindspore.Tensor.to_csr
mindspore.Tensor.to_tensor mindspore.Tensor.to_tensor
mindspore.Tensor.top_k mindspore.Tensor.topk
mindspore.Tensor.trace mindspore.Tensor.trace
mindspore.Tensor.transpose mindspore.Tensor.transpose
mindspore.Tensor.tril mindspore.Tensor.tril

View File

@ -285,7 +285,7 @@
mindspore.Tensor.to_coo mindspore.Tensor.to_coo
mindspore.Tensor.to_csr mindspore.Tensor.to_csr
mindspore.Tensor.to_tensor mindspore.Tensor.to_tensor
mindspore.Tensor.top_k mindspore.Tensor.topk
mindspore.Tensor.trace mindspore.Tensor.trace
mindspore.Tensor.transpose mindspore.Tensor.transpose
mindspore.Tensor.tril mindspore.Tensor.tril

View File

@ -342,7 +342,7 @@ Comparison Functions
mindspore.ops.ne mindspore.ops.ne
mindspore.ops.not_equal mindspore.ops.not_equal
mindspore.ops.msort mindspore.ops.msort
mindspore.ops.top_k mindspore.ops.topk
Linear Algebraic Functions Linear Algebraic Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -3368,7 +3368,7 @@ def ceil(x):
def topk(input_x, k, dim=None, largest=True, sorted=True): def topk(input_x, k, dim=None, largest=True, sorted=True):
r""" r"""
For details, please refer to :func:`mindspore.ops.top_k`. For details, please refer to :func:`mindspore.ops.topk`.
""" """
return F.topk(input_x, k, dim, largest=largest, sorted=sorted) return F.topk(input_x, k, dim, largest=largest, sorted=sorted)

View File

@ -3467,7 +3467,7 @@ class Tensor(Tensor_):
def topk(self, k, dim=None, largest=True, sorted=True): def topk(self, k, dim=None, largest=True, sorted=True):
r""" r"""
For details, please refer to :func:`mindspore.ops.top_k`. For details, please refer to :func:`mindspore.ops.topk`.
""" """
self._init_check() self._init_check()
return tensor_operator_registry.get("topk")(self, k, dim, largest, sorted) return tensor_operator_registry.get("topk")(self, k, dim, largest, sorted)