torcheval.metrics.functional.multiclass_f1_score¶

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

计算f1分数，它被定义为精确率和召回率的调和平均数。当f1分数为NaN时，我们将NaN转换为零。这种情况发生在精确率或召回率为NaN，或者精确率和召回率都为零时。它的类版本是torcheval.metrics.MultiClassF1Score。

Parameters:

输入 (张量) – 标签预测的张量。它可以是预测的标签，形状为 (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 import multiclass_f1_score
>>> input = torch.tensor([0, 2, 1, 3])
>>> target = torch.tensor([0, 1, 2, 3])
>>> multiclass_f1_score(input, target, num_classes=4)
tensor(0.5000)

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

>>> input = torch.tensor([0, 0, 1, 1, 1])
>>> target = torch.tensor([0, 0, 0, 0, 1])
>>> multiclass_f1_score(input, target, num_classes=2, average="macro")
tensor(0.5833)

>>> 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])
>>> multiclass_f1_score(input, target, num_classes=4)
tensor(0.5)