torcheval.metrics.MulticlassPrecision¶
- class torcheval.metrics.MulticlassPrecision(*, num_classes: int | None = None, average: str | None = 'micro', device: device | None = None)¶
计算精确率得分,它是真阳性数与真阳性数和假阳性数之和的比率。它的函数版本是
torcheval.metrics.functional.multiclass_precision()
。如果某些类别在预测中没有实例,我们会将 NaN 转换为 0。- 参数:
num_classes (int) – 类别数量。
average (str) –
"micro"
(默认): 全局计算指标。"macro"
: 为每个类别分别计算指标,并返回它们的未加权平均值。真实例和预测实例都为 0 的类别将被忽略。"weighted"
: 为每个类别分别计算指标,并返回它们的加权总和。权重定义为每个类别在“target”中出现的比例。真实例和预测实例都为 0 的类别将被忽略。None
: 为每个类别分别计算指标,并返回每个类别的指标。
示例
>>> import torch >>> from torcheval.metrics import MulticlassPrecision >>> metric = MulticlassPrecision(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 = MulticlassPrecision(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 = MulticlassPrecision(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 = MulticlassPrecision(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
的双端队列。
方法
__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()
的最后一个输入设备。