mindspore/docs/api/api_python/ops/mindspore.ops.TopK.rst

37 lines
1.9 KiB
ReStructuredText
Raw Normal View History

mindspore.ops.TopK
===================
.. py:class:: mindspore.ops.TopK(sorted=True)
沿最后一个维度查找 `k` 个最大元素和对应的索引。
2023-01-18 11:08:01 +08:00
.. warning::
2023-02-20 17:43:11 +08:00
- 如果 `sorted` 设置为False它将使用aicpu运算符性能可能会降低另外由于在不同平台上存在内存排布以及遍历方式不同等问题`sorted` 设置为False时计算结果的显示顺序可能会出现不一致的情况。
2023-01-18 11:08:01 +08:00
如果 `input_x` 是一维Tensor则查找Tensor中 `k` 个最大元素并将其值和索引输出为Tensor。`values[k]``input_x``k` 个最大元素,其索引是 `indices[k]`
对于多维矩阵,计算每行中最大的 `k` 个元素(沿最后一个维度的相应向量),因此:
.. math::
values.shape = indices.shape = input.shape[:-1] + [k].
如果两个比较的元素相同,则优先返回索引值较小的元素。
参数:
2023-02-20 17:43:11 +08:00
- **sorted** (bool, 可选) - 如果为True则获取的元素将按值降序排序。如果为False则不对获取的元素进行排序。默认值True。
2023-01-18 11:08:01 +08:00
输入:
2023-02-27 12:46:28 +08:00
- **input_x** (Tensor) - 需计算的输入CPU推理数据类型必须为float16、float32或int32GPU推理数据类型必须为float16或float32。
2023-01-18 11:08:01 +08:00
- **k** (int) - 指定计算最大元素的数量,必须为常量。
输出:
`values``indices` 组成的tuple。
- **values** (Tensor) - 最后一个维度的每个切片中的 `k` 最大元素。
- **indices** (Tensor) - `k` 最大元素的对应索引。
异常:
- **TypeError** - 如果 `sorted` 不是bool。
- **TypeError** - 如果 `input_x` 不是Tensor。
- **TypeError** - 如果 `k` 不是int。
- **TypeError** - 如果 `input_x` 的数据类型不是以下之一float16、float32或int32。