# ohem_loss

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

一个损失包装器，仅对最难的元素进行平均。

## 类

### OHEMLoss

用于像素或类别损失的在线难例挖掘包装器。

 * `Inputs:`: * `predictions` (`Tensor`): `[B, C, ...]` logits，传递给准则
    * `target` (`Tensor`): 任务的标签，传递给准则
 * `Outputs:`: * `Tensor`: 标量
 * `Formula:`: 准则计算每个元素的损失，`reduction="none"`。损失将这 n 个值按降序排序，即 ℓ0 ≥ ℓ1 ≥ …。使用比率 r = `ohem_ratio` 和概率 p = `ohem_threshold`： k =
   min(⌊r n⌋, n − 1), τ = − lnp 当 ℓk > τ 时，损失是所有高于 τ 的值的平均值。否则，损失是 k 个最大值的平均值。对于没有类别权重和标签平滑的交叉熵，高于 τ 的值意味着目标预测概率低于 p。

> **References**
> * 来源: 本项目。
 * 许可证: Apache-2.0 (本项目)

> **Notes**
> `criterion="auto"` 为只有一个类别的节点选择 [BCEWithLogitsLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/bce_with_logits.md)，否则选择 [CrossEntropyLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/cross_entropy.md)。当 k = 0 且 ℓ0 ≤ τ 时，损失返回 `nan`，因为没有值的平均值是 `nan`。对于没有元素的输入，它返回元素损失的空张量。

> **Example**
> 在 `model.nodes` 中附加到 `DDRNetSegmentationHead`：

```yaml
- name: DDRNetSegmentationHead
  inputs: [DDRNet]
  losses:
    - name: OHEMLoss
```

 * `Compatible with:`: * 使用者:
   [SegmentationModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/predefined_models/segmentation/v1/model.md)
    * 节点: *
      [BiSeNetHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/bisenet_head.md)
       * [ClassificationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/classification_head.md)
       * [DDRNetSegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ddrnet_segmentation_head.md)
       * [SegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/segmentation_head.md)
       * [TransformerClassificationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/transformer_classification_head.md)
       * [TransformerSegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/transformer_segmentation_head.md)

#### 方法

##### init

```python
def __init__(criterion: str | type[BaseLoss] | Literal['auto'] = 'auto', ohem_ratio: float = 0.1, ohem_threshold: float = 0.7, **kwargs):
```

初始化损失并创建准则。

该方法使用 `**kwargs` 和 `reduction="none"` 创建准则，因此准则必须接受 `reduction`。

参数

 * `criterion` (`str | type[BaseLoss] | Literal['auto']`): 计算每个元素值的损失。字符串名称是
   [LOSSES](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/registry.md)
   注册表中的损失，例如 `"CrossEntropyLoss"`。未知名称会引发 `KeyError`。该方法使用
   [BaseLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
   子类。当节点只有一个类时，`"auto"` 选择 `"BCEWithLogitsLoss"`，否则选择 `"CrossEntropyLoss"`。然后该方法会记录有关推断任务的警告。如果没有节点，`"auto"` 会引发 `ValueError`。
 * `ohem_ratio` (`float`): 比率 r，用于设置当 ℓk ≤ τ 时损失保留的最大值数量 k。
 * `ohem_threshold` (`float`): 概率 p，用于设置损失阈值 τ = − lnp。
 * `**kwargs`: 转发给
   [BaseLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
   和准则的关键字参数，例如 `final_loss_weight` 和 `node`。两者接收相同的参数，因此只有准则接受的参数（例如 `label_smoothing`）会引发 `TypeError`。

##### forward

```python
def forward(predictions: Tensor, target: Tensor) -> Tensor:
```

计算准则损失并平均最难的元素。

准则给出每个元素的损失。该方法将这些损失展平并保留最难的损失，如类公式所述。

> **Example**
> 四个元素的交叉熵为 `0.1269` 或 `2.1269`。当 `ohem_ratio=0.5` 时，k 为 `2`，ℓ2 为 `0.1269`。默认阈值给出 τ = − ln0.7 ≈ 0.357，因此损失保留两个最大值。阈值 `0.9` 给出 τ ≈ 0.105，因此损失保留所有高于它的值：

```pycon
>>> import torch
>>> logits = torch.tensor([[2.0, 0.0], [0.0, 2.0]]).repeat(2, 1)
>>> target = torch.tensor([0, 0, 1, 1])
>>> loss = OHEMLoss("CrossEntropyLoss", ohem_ratio=0.5)
>>> round(loss(logits, target).item(), 4)
2.1269
>>> loss = OHEMLoss(
...     "CrossEntropyLoss", ohem_ratio=0.5, ohem_threshold=0.9
... )
>>> round(loss(logits, target).item(), 4)
1.1269
```

参数

 * `predictions` (`Tensor`): 节点的主要输出，传递给准则。对于默认准则，形状为 `[B, C, ...]` 的 logits。
 * `target` (`Tensor`): 任务的单个标签，例如形状为 `[B, C, H, W]` 的 `segmentation` 标签，传递给准则。

返回

 * `Tensor`: 保留的元素损失的平均值，作为标量。当方法不保留任何元素时，值为 `nan`。对于没有元素的输入，该方法返回元素损失的空张量。

#### 属性

##### criterion

##### supported_tasks
