torch.topk

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

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

如果未给定 dim，则选择 input 的最后一个维度。

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

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

布尔选项 sorted 如果为 True，将确保返回的 k 个元素本身已排序

参数

• input (Tensor) – 输入张量。

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

• dim (int, 可选) – 要沿其排序的维度

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

• sorted (bool, 可选) – 控制是否以排序顺序返回元素

关键字参数

out (tuple, 可选) – 可选给出的输出元组 (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]))