base_metric
最后更新
luxonis_train.attached_modules.metrics.base_metric所有指标的基类和指标状态的标记。BaseMetric 将 BaseAttachedModule 与 torchmetrics 的 Metric 类结合。 MetricState 标记 BaseMetric 注册为指标状态的类属性。 DistReduceFx 是合并跨进程状态的归约类型,MetricResult 是 BaseMetric.compute 结果的类型。类
BaseMetric
torchmetrics 的 Metric。每个子类都会在 METRICS 注册表中以其类名注册自己,除非其类语句传递 register=False。配置通过该字符串命名注册的指标。子类实现 update 和 compute。它使用 MetricState 声明其状态,或者在其 __init__ 中使用 add_state。 MetricState 的示例展示了一个完整的子类。BaseAttachedModule.get_parameters 描述了 run_update 如何从预测和标签中填充 update 的参数。训练器在每个验证和测试批次上调用 run_update。在 epoch 结束时,它调用 compute 并记录 get_artifacts 的图像。然后它调用 reset 并记录 get_loggable_values 选择的值。只有当两个指标是同一个对象时,它们才相等,指标的哈希值是其 id。在 torchmetrics 中,== 构建一个新的组合指标,哈希值读取状态。方法
init
Python
1def __init__(**kwargs):torchmetrics 的 add_state 方法注册每个 Annotated 提示包含 MetricState 的属性。 MetricState 描述了状态的默认值和归约如何遵循标记。参数**kwargs: 转发给 BaseAttachedModule 的关键字参数,例如node。其余参数到达torchmetrics的Metric,它只接受自己的选项,例如sync_on_compute,并对任何其他名称引发ValueError。
ValueError: 当指标状态没有default且其类型既不是Tensor也不是list[...]时。当指标状态的default是一个非空列表时。
compute
Python
1def compute(self) -> Tensor | tuple[Tensor, dict[str, Tensor]] | dict[str, Tensor]:Tensor | tuple[Tensor, dict[str, Tensor]] | dict[str, Tensor]: 结果有三种形式。- 主值作为
Tensor。 - 主值和子指标字典的元组。
- 仅子指标字典。训练器不会在指标名称下记录任何值,因此该指标不能作为主指标。
- 主值作为
get_artifact_names
Python
1def get_artifact_names(self) -> tuple[str, ...]:tuple[str, ...]: get_artifacts 返回的字典的键。
get_artifacts
Python
1def get_artifacts(values: MetricResult) -> dict[str, Tensor]:values(MetricResult): compute 的结果。
dict[str, Tensor]: 形状为[C, H, W]的图像,键为 get_artifact_names 返回的名称。
get_loggable_values
Python
1def get_loggable_values(values: MetricResult) -> MetricResult:values(MetricResult): compute 的结果。
MetricResult: 要记录的值,采用 compute 的一种形式。
get_predefined_model_params_aliases
Python
1def get_predefined_model_params_aliases(task: Task | None = None) -> dict[str, str]:params 添加 per_class_metrics。当 Nodes 构建指标时,它会在返回的字典中查找键,并以找到的参数名称传递值。当字典中没有此类键时,Nodes 会丢弃该值并记录警告。它会丢弃 None 值而不进行查找。此实现忽略 task 并返回类属性 predefined_model_params_aliases。该属性在 BaseMetric 上为空,MIoU 将 per_class_metrics 映射到 per_class。 MeanAveragePrecision 不是子类。它定义自己的方法,因为其映射取决于任务。示例
Pycon
1>>> from luxonis_train.attached_modules.metrics import MIoU
2>>> BaseMetric.get_predefined_model_params_aliases()
3{}
4>>> MIoU.get_predefined_model_params_aliases()
5{'per_class_metrics': 'per_class'}task(Task | None): 指标附加到的节点的任务,如果节点没有任务,则为None。
dict[str, str]: 预定义模型参数名称,映射到构造函数的参数名称。
run_update
Python
1def run_update(inputs: Packet[Tensor], labels: Labels):inputs(Packet[Tensor]): 节点的输出包。labels(Labels): 批次的标签,键为<task_name>/<label>。
update
Python
1def update(*args: Tensor | list[Tensor]):*args(Tensor | list[Tensor]): 批次的输入。实现会用命名参数替换它们。
属性
predefined_model_params_aliases
MetricState
Annotated 类型提示中。 BaseMetric.init 在类及其基类中查找每个此类属性。它使用 torchmetrics 的 add_state 方法注册该属性,因此状态是指标实例的属性。 Annotated 的第一个参数是状态的类型。torchmetrics 将状态视为缓冲区:.to() 移动它。 reset 为张量状态提供其默认值的副本,并清空列表状态。示例
具有两个张量状态的子类。
register=False 使该类不包含在 METRICS 注册表中。Pycon
1>>> from typing import Annotated
2>>> import torch
3>>> from torch import Tensor
4>>> class PositiveRate(BaseMetric, register=False):
5... positives: Annotated[Tensor, MetricState()]
6... total: Annotated[Tensor, MetricState(default=0)]
7...
8... def update(self, predictions: Tensor) -> None:
9... self.positives += (predictions > 0).sum()
10... self.total += predictions.numel()
11...
12... def compute(self) -> Tensor:
13... return self.positives / self.total
14>>> metric = PositiveRate()
15>>> metric.update(torch.tensor([1.0, -1.0, 2.0, 3.0]))
16>>> metric.compute().item()
170.75
18>>> metric.reset()
19>>> metric.positives.item(), metric.total.item()
20(0.0, 0)属性
default
reset 后的状态值。数字变为零维张量,因此 0 给出 int64 状态,0.0 给出 float32 状态。 None 为 Tensor 属性选择 0.0,为 list[...] 属性选择 []。对于任何其他类型的属性,None 会使 BaseMetric.init 引发 ValueError。列表默认值必须为空,否则 add_state 会引发 ValueError。 每个实例都会按原样接收张量或列表默认值,而不是副本。 类的所有实例然后共享一个状态对象。一个指标中的就地更改(例如 += 或 append)也会更改其他指标。 reset 为一个指标提供一个新的张量,因此该指标不再共享张量状态。 reset 就地清空列表状态,因此列表保持共享并对所有指标清空。数字或 None 为每个实例提供自己的状态。dist_reduce_fx
torch.sum、torch.mean、torch.cat、torch.min 或 torch.max 沿维度 0。可调用对象接收收集到的状态:沿新的第一个维度堆叠的张量状态,或包含所有进程项的一个列表。 None 保持收集到的状态不变。默认 ... 为列表状态选择 "cat",为张量状态选择 "sum"。persistent
state_dict 是否包含状态。