mindspore.ops.topk

mindspore.ops.topk(input, k, dim=None, largest=True, sorted=True)[源代码]

沿给定维度查找 k 个最大或最小元素和对应的索引。

警告

  • 如果 sorted 设置为False，它将使用aicpu运算符，性能可能会降低，另外，由于在不同平台上存在内存排布以及遍历方式不同等问题，sorted 设置为False时计算结果的显示顺序可能会出现不一致的情况。

如果 input 是一维Tensor，则查找Tensor中 k 个最大或最小元素，并将其值和索引输出为Tensor。 values[k] 是 input 中 k 个最大元素，其索引是 indices[k] 。

对于多维矩阵，计算给定维度中最大或最小的 k 个元素，因此：

\[values.shape = indices.shape\]

如果两个比较的元素相同，则优先返回索引值较小的元素。

参数：

  • input (Tensor) - 需计算的输入，数据类型必须为float16、float32或int32。

  • k (int) - 指定计算最大或最小元素的数量，必须为常量。

  • dim (int, 可选) - 需要排序的维度。默认值：None。

  • largest (bool, 可选) - 如果为False，则会返回前k个最小值。默认值：True。

  • sorted (bool, 可选) - 如果为True，则获取的元素将按值降序排序。如果为False，则不对获取的元素进行排序。默认值：True。

返回：

由 values 和 indices 组成的tuple。

  • values (Tensor) - 给定维度的每个切片中的 k 最大元素或最小元素。

  • indices (Tensor) - k 最大元素的对应索引。

异常：

  • TypeError - 如果 sorted 不是bool。

  • TypeError - 如果 input 不是Tensor。

  • TypeError - 如果 k 不是int。

  • TypeError - 如果 input 的数据类型不是以下之一：float16、float32或int32。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore as ms
>>> from mindspore import ops
>>> x = ms.Tensor([[0.5368, 0.2447, 0.4302, 0.9673],
...                [0.4388, 0.6525, 0.4685, 0.1868],
...                [0.3563, 0.5152, 0.9675, 0.8230]], dtype=ms.float32)
>>> output = ops.topk(x, 2, dim=1)
>>> print(output)
(Tensor(shape=[3, 2], dtype=Float32, value=
[[ 9.67299998e-01,  5.36800027e-01],
 [ 6.52499974e-01,  4.68499988e-01],
 [ 9.67499971e-01,  8.23000014e-01]]), Tensor(shape=[3, 2], dtype=Int32, value=
[[3, 0],
 [1, 2],
 [2, 3]]))
>>> output2 = ops.topk(x, 2, dim=1, largest=False)
>>> print(output2)
(Tensor(shape=[3, 2], dtype=Float32, value=
[[ 2.44700000e-01,  4.30200011e-01],
 [ 1.86800003e-01,  4.38800007e-01],
 [ 3.56299996e-01,  5.15200019e-01]]), Tensor(shape=[3, 2], dtype=Int32, value=
[[1, 2],
 [3, 0],
 [0, 1]]))