# base_loss

Python API: `luxonis_train.attached_modules.losses.base_loss`

所有损失都继承的基类。

## 类

### BaseLoss

所有损失的基类。

每个子类都会在
[LOSSES](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/registry.md)
注册表中注册自己，除非其类语句传递 `register=False`。类语句中的 `register_name` 会替换类名。配置会在节点的 `losses` 列表中命名一个已注册的损失。子类实现
[forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)。

[BaseAttachedModule.get_parameters](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
描述了
[run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
如何从预测和标签中填充
[forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
的参数。

训练器在每个训练、验证和测试批次上调用
[run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)。它将所有损失的主要值求和到总损失中。训练步骤只反向传播这个总损失。

> **示例**
> 示例损失读取节点输出的 `features` 键。主要值是均值，子损失 `"max"` 是最大值。[run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md) 只将主要值乘以 `final_loss_weight`。`register=False` 使该类不包含在 [LOSSES](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/registry.md) 注册表中。

```pycon
>>> import torch
>>> from torch import Tensor
>>> class MeanLoss(BaseLoss, register=False):
...     def forward(
...         self, features: Tensor
...     ) -> tuple[Tensor, dict[str, Tensor]]:
...         return features.mean(), {"max": features.max()}
>>> loss = MeanLoss(final_loss_weight=2.0)
>>> packet = {"features": torch.tensor([1.0, 3.0])}
>>> main, sub_losses = loss.run(packet, {})
>>> main.item(), sub_losses["max"].item()
(4.0, 3.0)
```

#### 方法

##### init

```python
def __init__(final_loss_weight: float = 1.0, **kwargs):
```

初始化损失并存储其主要值的因子。

参数

 * `final_loss_weight` (`float`):
   [run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
   乘以损失主要值的因子。子损失保持未缩放。训练器在此处传递损失配置的 `weight`。
 * `**kwargs`: 转发给
   [BaseAttachedModule](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
   的关键字参数，例如 `node`。

##### forward

```python
def forward(*args: Tensor | list[Tensor]) -> Tensor | tuple[Tensor, dict[str, Tensor]]:
```

计算一个批次的损失。

实现声明每个输入一个命名参数。[run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
按名称填充参数，如类文档字符串所述，并将它们作为关键字参数传递。张量是副本，因此就地更改不会影响节点输出或标签。

参数

 * `*args` (`Tensor | list[Tensor]`): 批次的输入。实现会用命名参数替换它们。

返回

 * `Tensor | tuple[Tensor, dict[str, Tensor]]`: 损失的主要值，或主要值和子损失字典的元组。训练器仅在 `trainer.log_sub_losses` 为 `True`
   时记录子损失。总损失不包括它们，因此它们不会影响梯度。

##### run

```python
def run(inputs: Packet[Tensor], labels: Labels) -> Tensor | tuple[Tensor, dict[str, Tensor]]:
```

解析
[forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
的输入并应用损失权重。

[BaseAttachedModule.get_parameters](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
记录了参数名称如何选择预测和标签。

参数

 * `inputs` (`Packet[Tensor]`): 节点的输出包。
 * `labels` (`Labels`): 批次的标签，键为 `<task_name>/<label>`。

返回

 * `Tensor | tuple[Tensor, dict[str, Tensor]]`:
   [forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
   的结果，其中 `final_loss_weight` 应用于主要值。子损失保持未缩放。
