torcheval.metrics.TopKMultilabelAccuracy

class torcheval.metrics.TopKMultilabelAccuracy(*, criteria: str = 'exact_match', k: int = 1, device: device | None = None)

计算多标签准确率分数，即预测的前k个标签与目标匹配的频率。 其功能版本是 torcheval.metrics.functional.topk_multilabel_accuracy()。

Parameters:

• criteria (string) –

  • 'exact_match' [默认]: 样本预测的top-k标签集必须与目标中的相应标签集完全匹配。也称为子集准确性。

  • 'hamming': 正确标签的top-k分数除以标签总数。

  • 'overlap': 样本预测的top-k标签集必须与目标中的相应标签集重叠。

  • 'contain': 样本预测的top-k标签集必须包含目标中的相应标签集。

  • 'belong': 样本预测的top-k标签集必须（完全）属于目标中的相应标签集。

• k (int) – 要考虑的顶部概率的数量。K 应该是一个大于或等于 1 的整数。

示例：

>>> import torch
>>> from torcheval.metrics import TopKMultilabelAccuracy
>>> metric = TopKMultilabelAccuracy(k = 2)
>>> input = torch.tensor([[0.1, 0.5, 0.2], [0.3, 0.2, 0.1], [0.2, 0.4, 0.5], [0, 0.1, 0.9]])
>>> target = torch.tensor([[1, 1, 0], [0, 1, 0], [1, 1, 1], [0, 1, 0]])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0)  # 0 / 4

>>> metric = TopKMultilabelAccuracy(criteria="hamming", k=2)
>>> input = torch.tensor([[0.1, 0.5, 0.2], [0.3, 0.2, 0.1], [0.2, 0.4, 0.5], [0, 0.1, 0.9]])
>>> target = torch.tensor([[1, 1, 0], [0, 1, 0], [1, 1, 1], [0, 1, 0]])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.583)  # 7 / 12

>>> metric = TopKMultilabelAccuracy(criteria="overlap", k=2)
>>> input = torch.tensor([[0.1, 0.5, 0.2], [0.3, 0.2, 0.1], [0.2, 0.4, 0.5], [0, 0.1, 0.9]])
>>> target = torch.tensor([[1, 1, 0], [0, 1, 0], [1, 1, 1], [0, 1, 0]])
>>> metric.update(input, target)
>>> metric.compute()
tensor(1)  # 4 / 4

>>> metric = TopKMultilabelAccuracy(criteria="contain", k=2)
>>> input = torch.tensor([[0.1, 0.5, 0.2], [0.3, 0.2, 0.1], [0.2, 0.4, 0.5], [0, 0.1, 0.9]])
>>> target = torch.tensor([[1, 1, 0], [0, 1, 0], [1, 1, 1], [0, 1, 0]])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.5)  # 2 / 4

>>> metric = TopKMultilabelAccuracy(criteria="belong", k=2)
>>> input = torch.tensor([[0.1, 0.5, 0.2], [0.3, 0.2, 0.1], [0.2, 0.4, 0.5], [0, 0.1, 0.9]])
>>> target = torch.tensor([[1, 1, 0], [0, 1, 0], [1, 1, 1], [0, 1, 0]])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.25)  # 1 / 4

__init__(*, criteria: str = 'exact_match', k: int = 1, device: device | None = None) → None

初始化一个度量对象及其内部状态。

使用 self._add_state() 来初始化你的度量类的状态变量。 状态变量应该是 torch.Tensor，一个 torch.Tensor 的列表，一个以 torch.Tensor 为值的字典， 或者一个 torch.Tensor 的双端队列。

方法

__init__(*[, criteria, k, device])	初始化一个度量对象及其内部状态。
compute()	返回准确率分数。
load_state_dict(state_dict[, strict])	从state_dict加载度量状态变量。
merge_state(metrics)	实现此方法以将当前度量的状态变量更新为当前度量和输入度量的合并状态。
reset()	将度量状态变量重置为其默认值。
state_dict()	将度量状态变量保存在state_dict中。
to(device, *args, **kwargs)	将度量状态变量中的张量移动到设备。
update(input, target)	使用真实标签和预测更新状态。

属性

device

Metric.to()的最后一个输入设备。