torch.topk

torch.topk(input, k, dim=None, largest=True, sorted=True, *, out=None)

返回给定 input 张量沿指定维度上的 k 个最大元素。

如果未指定 dim，则选取 input 张量的最后一维。

如果 largest 为 False，则返回 k 个最小元素。

返回一个 namedtuple (values, indices)，其中包含输入张量在指定维度 dim 上每行的 k 个最大元素的 values 和 indices。

布尔选项 sorted，如果为 True，将确保返回的 k 个元素自身也是有序的

注意

使用 torch.topk 时，相同值元素的索引不保证稳定性，在不同调用中可能会有所不同。

参数

• input (Tensor) – 输入张量。

• k (int) – “top-k” 中的 k

• dim (int, optional) – 沿其排序的维度

• largest (bool, optional) – 控制返回最大元素还是最小元素

• sorted (bool, optional) – 控制返回的元素是否按顺序排列

关键字参数

out (tuple, optional) – 可选提供的输出元组 (Tensor, LongTensor)，用作输出缓冲区

示例

>>> x = torch.arange(1., 6.)
>>> x
tensor([ 1.,  2.,  3.,  4.,  5.])
>>> torch.topk(x, 3)
torch.return_types.topk(values=tensor([5., 4., 3.]), indices=tensor([4, 3, 2]))