# classification_head

Python API: `luxonis_train.nodes.heads.classification_head`

一个带有池化、dropout 和线性层的分类头。

## 类

### ClassificationHead

带有一个线性层的分类头。

 * `输入:`: * `inputs` (`Tensor`): [B, C, h, w]
 * `输出:`: * `classification` (`Tensor`): [B, nclasses] logits

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

> **注意事项**
> 头部应用全局平均池化、dropout 和一个线性层。特征图可以有任意高度 h 和宽度 w。`forward` 不检查模式，因此导出模式也提供 logits。dropout 仅在训练模式下起作用。

 * `变体:`: 无。通过 `params` 配置节点。

> **示例**
> 配置中 `model.nodes` 部分的节点条目：

```yaml
- name: ClassificationHead
  inputs: [ResNet]
```

 * `兼容:`: * 附加索引：`-1`，输入节点的最后一个输出
    * 所需标签：`classification`
    * 使用者：[ClassificationModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/predefined_models/classification/v1/model.md)
    * 损失： *
      [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)
       * [OHEMLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/ohem_loss.md)
       * [SigmoidFocalLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/sigmoid_focal_loss.md)
       * [SmoothBCEWithLogitsLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/smooth_bce_with_logits.md)
       * [SoftmaxFocalLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/softmax_focal_loss.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)
       * [JaccardIndex](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/torchmetrics.md)
       * [Precision](/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)
    * 导出解析器：`ClassificationParser`

#### 方法

##### init

```python
def __init__(dropout_rate: float = 0.2, **kwargs):
```

构建池化、dropout 和线性层。

参数

 * `dropout_rate` (`float`): 在训练模式下，dropout 层将池化特征设置为零的概率，范围为 `[0, 1]`。
 * `**kwargs`:
   [BaseNode](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
   的关键字参数。它们必须包含 `input_shapes` 或 `in_sizes`，以及通过 `n_classes` 或 `dataset_metadata` 指定的类别计数。

##### forward

```python
def forward(inputs: Tensor) -> Tensor:
```

计算类别 logits。

> **示例**
> ```pycon
>>> import torch
>>> from torch import Size
>>> from luxonis_train.nodes import ClassificationHead
>>> head = ClassificationHead(
...     n_classes=4,
...     input_shapes=[{"features": [Size([2, 16, 7, 7])]}],
... )
>>> head(torch.zeros(2, 16, 7, 7)).shape
torch.Size([2, 4])
```

参数

 * `inputs` (`Tensor`): 形状为 `[B, C, h, w]` 的特征图。

返回

 * `Tensor`: 形状为 `[B, n_classes]` 的 logits。[BaseNode.run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md) 将它们放在 `"classification"` 键下。

##### get_custom_head_config

```python
def get_custom_head_config(self) -> Params:
```

返回 NN Archive 的头部特定元数据。

子类重写此方法以向其解析器提供更多值。[get_head_config](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/base_head.md) 将结果合并到 `"metadata"` 字典中。基本实现返回一个空字典。

返回

 * `Params`: 附加的元数据键及其值。

#### 属性

##### head

##### in_channels

附加输入的通道数。

它是 [in_sizes](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md) 倒数第三个维度，因此带或不带批处理维度的形状给出相同的值。大小列表给出通道计数的列表。

引发

 * `RuntimeError`: 当 [in_sizes](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md) 找不到输入大小时。
 * `ValueError`: 当 [attach_index](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md) 不适合大小时。

##### parser
