base_attached_module
最后更新
luxonis_train.attached_modules.base_attached_module所有损失、指标和可视化工具的基类。BaseAttachedModule 检查模块是否适合任务及其节点的类型。BaseAttachedModule.get_parameters 根据模块的参数名称,从节点的输出包和标签中选择模块的输入。类
BaseAttachedModule
- 设置类属性
supported_tasks。 - 在类主体中注释
node,例如node: OCRCTCHead。如果节点不是该类的实例,则构造函数会引发 IncompatibleError。检查只读取具有注释的最近类的注释。因此,子类的注释会隐藏其父类的node注释。
RuntimeError。方法
init
Python
1def __init__(*, node: BaseNode | None = None, **kwargs):supported_tasks 的唯一项成为任务。在其他情况下,模块没有任务,并且 task 会引发 RuntimeError。参数node(BaseNode | None): 模块附加到的节点。训练器会传递它。None会使读取节点的属性引发RuntimeError。**kwargs: 转发到下一个基类的关键字参数。对于指标,它是torchmetricsMetric。对于损失或可视化工具,它是torch.nn.Module,它会为任何关键字参数引发TypeError。
IncompatibleError: 当节点的任务不在supported_tasks中,或者当节点不是node注释中类的实例时。
get_parameters
Python
1def get_parameters(predictions: Packet[Tensor], labels: Labels | None = None) -> dict[str, Tensor | list[Tensor] | None]:self、kwargs 和可视化工具的画布。它根据参数名称为每个参数选择一个值:- 以
target开头的名称选择一个标签。第一个下划线之后的部分是标签,因此target_boundingbox选择<task_name>/boundingbox。没有下划线的名称(例如target)选择 required_labels 中的唯一标签。 - 以
pred开头的名称选择第一个下划线之后的包键。没有下划线的名称(例如predictions)选择 task 的main_output。 - 任何其他名称选择该名称的包键。
<task_name> 是 node 的 task_name。该方法克隆每个选定的张量,以及选定列表的每个张量。当缺少值时,用 | None 注释的参数会得到 None。具有默认值的另一个参数不会得到条目,因此应用默认值。示例
缺失的可选值变为
None。选定的张量是副本:Pycon
1>>> import torch
2>>> from torch import Tensor
3>>> from luxonis_train.attached_modules.losses import BaseLoss
4>>> class Loss(BaseLoss, register=False):
5... def forward(
6... self, features: Tensor, scale: Tensor | None = None
7... ) -> Tensor:
8... return features.sum()
9>>> packet = {"features": torch.ones(2)}
10>>> kwargs = Loss().get_parameters(packet)
11>>> kwargs["scale"] is None
12True
13>>> kwargs["features"] is packet["features"]
14Falsepredictions(Packet[Tensor]): 节点的输出包。labels(Labels | None): 批次的标签,键为<task_name>/<label>。None充当空字典。
dict[str, Tensor | list[Tensor] | None]: 以参数名称为键的值,准备作为关键字参数传递。
RuntimeError: 当没有默认值的参数没有值时。当target名称没有下划线且任务不需要正好一个标签时。当名称需要模块没有的节点或任务时。TypeError: 当值与参数的注释不匹配时。
属性
classes
bidict。引发RuntimeError: 当模块没有节点,或者节点没有dataset_metadata时。ValueError: 当数据集没有具有节点task_name的任务时。
current_epoch
0 开始。该值来自 node。LuxonisLightningModule 在每个训练周期开始时在节点上设置它。引发RuntimeError: 当模块没有节点时。
n_classes
RuntimeError: 当模块没有节点,或者节点既没有n_classes也没有dataset_metadata时。ValueError: 当数据集没有具有节点task_name的任务时。
n_keypoints
0。引发RuntimeError: 当模块没有节点,或者节点既没有n_keypoints也没有dataset_metadata时。
name
node
RuntimeError: 当构造函数没有节点时。
original_in_shape
[C, H, W]。该值是 BaseNode.original_in_shape 的 node。该形状不包括批次维度。引发RuntimeError: 当模块没有节点,或者节点没有original_in_shape时。
required_labels
target 参数选择此集合中唯一的标签。引发RuntimeError: 当模块没有任务时。
supported_tasks
None 接受具有任何任务的节点。task
supported_tasks 中选择它。引发RuntimeError: 当模块没有任务时。