torcheval.metrics.MulticlassF1Score

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

计算 F1 分数，定义为精确率和召回率的调和平均数。当 F1 分数为 NaN 时，我们将 NaN 转换为零。当精确率或召回率为 NaN 或精确率和召回率都为零时，就会发生这种情况。其函数版本为 torcheval.metrics.functional.multi_class_f1_score()。

参数：

• num_classes (int) – 类别数量。

• average (str, 可选) –

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

  • 'macro'：分别计算每个类别的指标，并返回其未加权平均值。忽略真值和预测实例均为 0 的类别。

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

  • None：分别计算每个类别的指标，并返回每个类别的指标。

示例

>>> import torch
>>> from torcheval.metrics import MulticlassF1Score
>>> metric = MulticlassF1Score(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 = MulticlassF1Score(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 = MulticlassF1Score(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.5833)

>>> metric = MulticlassF1Score(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.5)

__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 的 deque。

方法

__init__(*[, num_classes, average, device])	初始化指标对象及其内部状态。
compute()	返回 F1 分数。
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() 的最后一个输入设备。