torcheval.metrics.functional.multiclass_recall¶

torcheval.metrics.functional.multiclass_recall(input: Tensor, target: Tensor, *, num_classes: int | None = None, average: str | None = 'micro') → Tensor¶

计算召回率得分，召回率是通过真正例（TP）的数量与实际正例总数（TP + FN）的比率来计算的。其类版本是 torcheval.metrics.MultiClassRecall。

Parameters:

input (Tensor) – 标签预测的张量它可以是预测的标签，形状为 (n_sample, )。它也可以是概率或logits，形状为 (n_sample, n_class)。 torch.argmax 将用于将输入转换为预测标签。
target (Tensor) – 形状为 (n_sample, ) 的真实标签张量。
num_classes – 类别数量。
average –
- 'micro' [默认]:
  通过使用所有类别的总真正例和假反例来全局计算指标。
- 'macro':
  分别计算每个类别的指标，并返回它们的未加权平均值。忽略真正例和预测实例为0的类别。
- 'weighted':
  分别计算每个类别的指标，并返回按target张量中每个类别的实例数加权的平均值。忽略真正例和预测实例为0的类别。
- None:
  分别计算每个类别的指标，并返回每个类别的指标。

示例：

>>> import torch
>>> from torcheval.metrics.functional.classification import multiclass_recall
>>> input = torch.tensor([0, 2, 1, 3])
>>> target = torch.tensor([0, 1, 2, 3])
>>> multiclass_recall(input, target)
tensor(0.5000)
>>> multiclass_recall(input, target, average=None, num_classes=4)
tensor([1., 0., 0., 1.])
>>> multiclass_recall(input, target, average="macro", num_classes=4)
tensor(0.5000)
>>> 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]])
>>> multiclass_recall(input, target)
tensor(0.5000)