# model

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

分类模型。

## 类

### ClassificationModel

单标签或多标签分类。

 * `吞吐量:`: 384x512 时的每秒帧数。 * `light`: RVC2 上 46，RVC4 上 176
    * `heavy`: RVC2 上 5，RVC4 上 134

> **注意事项**
> [F1Score](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md)、[Accuracy](https://docs.luxonis.com/zh/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md) 和 [Recall](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md) 封装了 `torchmetrics` 并从 `metrics_params` 读取 `task` 键。当图像可以包含多个类别时，将其设置为 `"multilabel"`。如果没有 `task` 和 `num_labels`，度量标准将为单个类别采用 `"binary"`，否则采用 `"multiclass"`，并记录警告。

[CrossEntropyLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/cross_entropy.md)
使用 `argmax` 将多热目标减少到一个类别。对于多标签数据，还要将 `loss` 设置为
[BCEWithLogitsLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/bce_with_logits.md)
等损失。

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

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

 * `组件:`: *
   节点：[ResNet](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/backbones/resnet.md)
   ->
   [ClassificationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/classification_head.md)
    * 损失：[CrossEntropyLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/cross_entropy.md)
    * 度量： *
      [Accuracy](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md)
       * [ConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/confusion_matrix.md)
       * [F1Score](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md)
       * [Recall](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md)
    * 可视化工具：[ClassificationVisualizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/classification_visualizer.md)
    * 主要度量：[F1Score](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md)
    * 变体： * `light`
       * `heavy`

#### 方法

##### init

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

从其组件名称初始化模型。

所有参数均为仅限关键字参数。`typechecked` 装饰器在运行时检查它们的类型。

> **注意事项**
> `backbone_params`、`neck_params` 或 `head_params` 中的 `freezing` 键包含该节点的 [FreezingConfig](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/config.md)，可以是实例或其字段的字典。没有 `active` 的字典会冻结节点。[nodes](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/predefined_models/base_predefined_model.md) 在构建配置时会删除该键。

参数

 * `backbone`: 注册骨干节点的类名。
 * `backbone_variant`: 骨干的变体。`None` 构建没有变体参数的骨干。
 * `head`: 注册头节点的类名。
 * `head_variant`: 头的变体。`None` 构建没有变体参数的头。
 * `neck`: 注册颈节点的类名。`None` 将头连接到骨干。
 * `neck_variant`: 颈的变体。`None` 构建没有变体参数的颈。
 * `loss`: 注册损失的类名。模型将其以 `1.0` 的权重附加到头。
 * `metrics`: 附加到头的注册度量的类名。字符串命名一个度量。`None` 不附加度量。
 * `main_metric`: 标记为主度量的度量。训练器将此度量的最高值检查点保存在 `best_val_metric` 中。`None` 采用 `metrics` 中的唯一名称，或者当 `metrics` 为空时不采用任何度量。不在 `metrics`
   中的名称不标记任何度量。当配置中没有度量被标记时，[ModelConfig.check_main_metric](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/config.md)
   标记第一个。
 * `visualizer`: 附加到头的注册可视化工具的类名。`None` 不附加可视化工具。
 * `confusion_matrix_available`: 头是否支持
   [ConfusionMatrix](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/confusion_matrix/confusion_matrix.md)
   度量。子类为其头设置它。
 * `backbone_params`: 骨干的构造函数参数。`freezing` 键不会到达构造函数。请参阅注意事项。
 * `neck_params`: 颈的构造函数参数，具有相同的 `freezing` 键。
 * `use_neck`: 构建颈。即使设置了 `neck`，`False` 也会省略颈，并且头从骨干读取。
 * `head_params`: 头的构造函数参数，具有相同的 `freezing` 键。
 * `loss_params`: 损失的构造函数参数。
 * `metrics_params`: `metrics` 中每个度量接收的构造函数参数。`enable_confusion_matrix` 添加的 `ConfusionMatrix` 度量不接收它们。
 * `visualizer_params`: 可视化工具的构造函数参数。
 * `enable_confusion_matrix`: 将 `ConfusionMatrix` 度量附加到头，不带主度量标志。当 `confusion_matrix_available` 为 `False` 时，它不起作用。
 * `confusion_matrix_params`: `ConfusionMatrix` 度量的构造函数参数。
 * `task_name`: 头读取的数据集任务。它成为头节点的 `task_name`。
 * `torchmetrics_task`: `metrics` 中每个度量接收的 `torchmetrics_task` 键的值。`None` 不添加键。该键进入 `metrics_params`，因此非空的 `metrics_params`
   字典会原地更改。此包中的任何度量都不读取该键。[TorchMetricWrapper](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md)
   度量读取 `task` 并将 `torchmetrics_task` 传递给 `torchmetrics`，这会引发 `ValueError`。请改为在 `metrics_params` 中为它们设置 `task`。
 * `per_class_metrics`: `metrics` 中每个度量接收的 `per_class_metrics` 键的值。`None` 不添加键。当
   [LuxonisLightningModule](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/lightning/luxonis_lightning.md)
   构建度量时，该键成为度量类声明的每个类参数。当类未声明任何参数时，模块会删除该键并记录警告。
 * `finetuning`: 每个组件的微调条目。每个字典都成为该节点的
   [FinetuningConfig](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/config.md)。
 * `**kwargs`

引发

 * `ValueError`: 当 `main_metric` 为 `None` 且 `metrics` 命名多个度量时。

##### get_variants

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

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

默认值为 `light`。两个变体都将 `backbone` 设置为 `"ResNet"`。它们在 `backbone_variant` 上有所不同：`light` 为 `"18"`，`heavy` 为 `"50"`。

> **示例**
> ```pycon
>>> default, variants = ClassificationModel.get_variants()
>>> default
'light'
>>> variants["heavy"]
{'backbone': 'ResNet', 'backbone_variant': '50'}
```

返回

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