# fomo_localization_loss

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

FOMO 对象中心热图的加权焦点损失。

## 类

### FOMOLocalizationLoss

[FOMOHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/fomo_head.md)
在对象中心热图上的焦点损失。

 * `输入:`: * `heatmap` (`Tensor`): [B, nclasses, Hf, Wf] logits
    * `target` (`Tensor`): [M, 6], `[batch, class, x, y, w, h]`, `xywh` 归一化
 * `输出:`: * `Tensor`: 标量
 * `公式:`: 目标热图 y 在包含框中心的单元格中为 `1`，在框类别的通道中。在所有其他单元格中为 `0`。对于每个单元格的 logit x: L = (1)/(B nclasses Hf Wf)∑α (1 − pt)γ w BCE(x, y), pt
   = exp( − BCE(x, y)) BCE 是带有 logits 的二元交叉熵，pt 是目标值的预测概率。w 在中心单元格中是 `object_weight`，在其他单元格中是 `1`。α 是 `alpha`，γ 是 `gamma`。

> **参考**
> * 来源：本项目。
 * 许可证：Apache-2.0（本项目）

> **注意事项**
> FOMO 任务没有关键点标签，因此损失使用框中心作为目标。具有归一化左上角 (x, y) 和大小 (w, h) 的框的中心位于列 ⌊(x + w ⁄ 2) Wf⌋ 和行 ⌊(y + h ⁄ 2) Hf⌋。同一类别的两个框，其中心位于同一单元格中，则生成一个目标单元格。与通常的焦点损失不同，α 以相同的因子缩放中心单元格和其他单元格。

> **示例**
> 附加到 `model.nodes` 中的 `FOMOHead`：

```yaml
- name: FOMOHead
  inputs: [EfficientRep]
  losses:
    - name: FOMOLocalizationLoss
```

 * `兼容:`: * 使用者:
   [FOMOModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/predefined_models/fomo/v1/model.md)
    * 节点:
      [FOMOHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/fomo_head.md)

#### 方法

##### init

```python
def __init__(object_weight: float = 500, alpha: float = 0.45, gamma: float = 2, **kwargs):
```

初始化损失。

该方法读取节点的输入图像大小。[forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/fomo_localization_loss.md)
不使用该大小。因此，损失需要一个节点：如果没有
`node`，[BaseAttachedModule.node](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/base_attached_module.md)
会引发 `RuntimeError`。

参数

 * `object_weight` (`float`): 中心单元格中损失的因子 w。其他单元格的因子为 `1`。
 * `alpha` (`float`): 每个单元格中损失的因子 α。
 * `gamma` (`float`): 焦点项的指数 γ。值越高，头部已经很好预测的单元格的损失越低。`0` 会移除焦点项。
 * `**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`。

##### forward

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

构建目标热图并计算加权焦点损失。

> **示例**
> 该示例使用 `4x4` 网格上零 logits 的热图。一个框的中心位于第 `2` 列和第 `2` 行。每个单元格都有二元交叉熵 ln2 和焦点因子 0.45⋅0.52。中心单元格的权重为 `500`，因此它贡献了大部分损失：

```pycon
>>> import torch
>>> from torch import Size
>>> from luxonis_train.nodes import FOMOHead
>>> sizes = [Size([1, 8, 8, 8]), Size([1, 16, 4, 4])]
>>> head = FOMOHead(
...     n_classes=1,
...     input_shapes=[{"features": sizes}],
...     original_in_shape=Size([3, 32, 32]),
... )
>>> heatmap = torch.zeros(1, 1, 4, 4)
>>> target = torch.tensor([[0.0, 0.0, 0.25, 0.25, 0.5, 0.5]])
>>> loss = FOMOLocalizationLoss(node=head)
>>> round(loss(heatmap, target).item(), 4)
2.51
>>> loss = FOMOLocalizationLoss(node=head, object_weight=1)
>>> round(loss(heatmap, target).item(), 4)
0.078
```

参数

 * `heatmap` (`Tensor`): 形状为 `[B, n_classes, H, W]` 的类别 logits，来自节点输出的 `heatmap` 键。
 * `target` (`Tensor`): 形状为 `[M, 6]` 的 `boundingbox` 标签。每行包含批次索引、类别以及一个框的归一化 `x`、`y`、`w` 和 `h`。`x` 和 `y` 表示左上角。

返回

 * `Tensor`: `heatmap` 所有单元格的加权焦点损失的平均值，作为标量。

#### 属性

##### node

##### supported_tasks
