# model

Python API: `luxonis_train.config.predefined_models.fomo.v1.model`

FOMO 检测模型。

## 类

### FOMOModel

FOMO，它为每个对象预测一个点而不是一个框。

头部预测一个热图，每个类别一个通道。热图的每个单元格覆盖图像的一个补丁，高值标记对象的中心。数据集需要边界框标签，损失函数将框的中心作为目标。

 * `吞吐量:`: 384x512 下的每秒帧数。 * `light`: RVC2 上 140，RVC4 上 243
    * `heavy`: RVC2 上 34，RVC4 上 230

> **注意事项**
> `loss_params` 中的 `object_weight` 乘以包含对象的单元格的损失，其默认值为 `500`。较大的值会提高召回率，同时也会增加误报的数量。

`head_params` 中的 `use_nms` 默认开启。在评估时，头部只保留 3x3 窗口中最大的单元格。这会消除一些误报，当两个对象靠得很近时，也会消除一些真阳性。在导出时，头部对热图应用 3x3 最大池化。

`head_params` 中的 `attach_index` 选择头部读取的骨干网络阶段，其默认值为 `1`。`0` 读取它之前的阶段。该阶段提供更大的热图和更精确的位置，并且模型运行速度较慢。

> **示例**
> 配置的 `model` 部分：

```yaml
model:
  predefined_model:
    name: FOMOModel
    params:
      variant: light
```

 * `组件:`: *
   节点：[EfficientRep](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/backbones/efficientrep/efficientrep.md)
   ->
   [FOMOHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/fomo_head.md)
    * 损失：[FOMOLocalizationLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/fomo_localization_loss.md)
    * 指标：[ConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/confusion_matrix.md)
    * 可视化器：[FOMOVisualizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/fomo_visualizer.md)
    * 主要指标：[ConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/confusion_matrix.md)
    * 变体： * `light`
       * `heavy`

#### 方法

##### init

```python
def __init__(**kwargs):
```

使用其默认组件初始化模型。

`ConfusionMatrix` 已经是主要指标，因此设置 `enable_confusion_matrix=False` 以避免添加第二个。

##### get_variants

```python
def get_variants() -> tuple[str, dict[str, Params]]:
```

获取默认变体名称和可用变体。

默认是 `light`。变体在骨干网络上有所不同：

 * `light`：[EfficientRep](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/backbones/efficientrep/efficientrep.md)
   使用 `"n"` 变体；
 * `heavy`：[MobileNetV2](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/backbones/mobilenetv2.md)
   没有变体。

两个变体都在 `head_params` 中将 `n_conv_layers` 设置为 `2`，将 `conv_channels` 设置为 `16`。配置中给出的 `head_params`
会替换变体的整个字典。然后，头部会为字典中未包含的键采用其自己的默认值。

> **示例**
> ```pycon
>>> default, variants = FOMOModel.get_variants()
>>> default
'light'
>>> variants["heavy"]
{'backbone': 'MobileNetV2',
 'head_params': {'n_conv_layers': 2, 'conv_channels': 16}}
```

返回

 * `tuple[str, dict[str, Params]]`：`"light"` 和两个变体及其构造函数参数。
