torcheval.metrics.MulticlassRecall

class torcheval.metrics.MulticlassRecall(*, num_classes: int | None = None, average: str | None = 'micro', device: device | None = None)

计算召回率分数，即真阳性数与真阳性数和假阴性数之和的比率。它的函数版本是 torcheval.metrics.functional.multiclass_recall()。当类在真值标签中没有实例时（当 TP + FN = 0 时），我们将 NaN 转换为 0。

参数：:

• num_classes (int) – 类别数。

• average (str, 可选) –

  • 'micro' [默认]: 全局计算指标。

  • 'macro': 为每个类单独计算指标，并返回它们的非加权平均值。忽略真值和预测实例均为 0 的类。

  • 'weighted'” 为每个类单独计算指标，并返回它们的加权和。权重定义为每个类在“目标”中出现的比例。忽略真值和预测实例均为 0 的类。

  • None: 为每个类单独计算指标，并返回每个类的指标。

示例

>>> import torch
>>> from torcheval.metrics.classification import MulticlassRecall
>>> metric = MulticlassRecall(num_classes=4)
>>> input = torch.tensor([0, 2, 1, 3])
>>> target = torch.tensor([0, 1, 2, 3])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.5000)

>>> metric = MulticlassRecall(average=None, num_classes=4)
>>> input = torch.tensor([0, 2, 1, 3])
>>> target = torch.tensor([0, 1, 2, 3])
>>> metric.update(input, target)
>>> metric.compute()
tensor([1., 0., 0., 1.])

>>> metric = MulticlassRecall(average="macro", num_classes=2)
>>> input = torch.tensor([0, 0, 1, 1, 1])
>>> target = torch.tensor([0, 0, 0, 0, 1])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.5000)

>>> metric = MulticlassRecall(num_classes=4)
>>> input = torch.tensor([[0.9, 0.1, 0, 0], [0.1, 0.2, 0.4, 0.3], [0, 1.0, 0, 0], [0, 0, 0.2, 0.8]])
>>> target = torch.tensor([0, 1, 2, 3])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.5000)

__init__(*, num_classes: int | None = None, average: str | None = 'micro', device: device | None = None) → None

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

使用 self._add_state() 初始化度量类状态变量。状态变量应为 torch.Tensor、torch.Tensor 列表、值类型为 torch.Tensor 的字典或 torch.Tensor 的双端队列。

方法

__init__(*[, num_classes, average, 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() 的最后一个输入设备。