torcheval.metrics.BinaryF1Score

class torcheval.metrics.BinaryF1Score(*, threshold: float = 0.5, device: device | None = None)

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

参数：

threshold (float, 可选) – 用于将输入转换为每个样本预测标签的阈值。将 torch.where(input < threshold, 0, 1) 应用于 input。

示例

>>> import torch
>>> from torcheval.metrics import BinaryF1Score
>>> metric = BinaryF1Score()
>>> input = torch.tensor([0, 1, 1, 0])
>>> target = torch.tensor([0, 1, 0, 1])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.5000)

>>> metric = BinaryF1Score(threshold=0.7)
>>> input = torch.tensor([.2, .8, .7, .6])
>>> target = torch.tensor([0, 1, 0, 1])
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.5000)
>>> input2 = torch.tensor([.9, .5, .1, .7])
>>> target2 = torch.tensor([0, 1, 1, 1])
>>> metric.update(input2, target2)
>>> metric.compute()
tensor(0.4444)

__init__(*, threshold: float = 0.5, device: device | None = None) → None

初始化指标对象及其内部状态。

使用 self._add_state() 初始化指标类的状态变量。状态变量应为 torch.Tensor、torch.Tensor 列表、以 torch.Tensor 作为值的字典或 torch.Tensor 的 deque。

方法

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

属性

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