# segmentation_head

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

FCN 分割头。

## 类

### SegmentationHead

带有双线性上采样步骤的基本 FCN 分割头。

 * `输入:`: * `inputs` (`Tensor`): [B, C, H ⁄ s, W ⁄ s]
 * `输出:`: * `segmentation` (`Tensor`): [B, nclasses, H, W] logits。当 s < 1 时，logits 保持特征图的大小：[B, nclasses, H ⁄ s, W ⁄ s]。

> **参考**
> * 来源：改编自 [torchvision FCN](https://github.com/pytorch/vision/blob/main/torchvision/models/segmentation/fcn.py) (BSD-3-Clause)。
 * 许可证：[BSD-3-Clause](https://github.com/pytorch/vision/blob/main/LICENSE)

> **注意事项**
> 步长 s 必须是 2n，高度和宽度相同。头部应用 n 个上采样步骤。每个步骤都是一个 [UpBlock](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/blocks/unet.md)：通过 `2` 进行双线性上采样，一个 `1x1` 卷积将通道减半，以及一个带有批归一化和 ReLU 的 `3x3` [ConvBlock](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/blocks/blocks.md)。最后一个 `1x1` 卷积为每个类别提供一个 logit 图。该模式不改变输出键或形状。这包括导出模式。

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

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

```yaml
- name: SegmentationHead
  inputs: [RepPANNeck]
```

 * `兼容:`: * 附加索引：`-1`，输入节点的最后一个输出
    * 所需标签：`segmentation`
    * 损失： *
      [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)
       * [DiceCoefficient](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/dice_coefficient.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)
       * [MIoU](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/metrics/mean_iou.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)
    * 可视化工具：[SegmentationVisualizer](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/visualizers/segmentation_visualizer.md)
    * 导出解析器：`SegmentationParser`

#### 方法

##### init

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

构建上采样步骤和类别卷积。

[infer_upscale_factor](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/general.md)
从特征图的大小和 `original_in_shape` 中的图像大小给出步骤数 n。当大小比率不是 2 的幂时，它会引发 `ValueError`。当高度比率与宽度比率不同时，它也会引发此错误。每个步骤将通道减半并向下取整。因此，最后一步有 ⌊c ⁄ 2n⌋
个通道，其中 c 是特征图的通道数。当特征图不小于图像时，n 为 `0` 或更小。此时，头部没有上采样步骤，logits 保持特征图的大小。

该类将
[BaseNode.in_channels](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)、[BaseNode.in_height](https://docs.luxonis.com/zh/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
和
[BaseNode.in_width](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
注释为 `int`。`attach_index` 为 `"all"` 或范围时会给出列表。因此，这样的 `attach_index` 会使构造函数引发
[IncompatibleError](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/exceptions.md)。

参数

 * `**kwargs` (`Any`):
   [BaseNode](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
   的关键字参数。它们必须包含 `original_in_shape`，通过 `input_shapes` 或 `in_sizes` 输入大小，以及通过 `n_classes` 或 `dataset_metadata` 输入类别计数。

##### forward

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

计算分割 logits。

> **示例**
> 步长为 `4` 的特征图获得两个上采样步骤：

```pycon
>>> import torch
>>> from torch import Size
>>> from luxonis_train.nodes import SegmentationHead
>>> head = SegmentationHead(
...     n_classes=3,
...     input_shapes=[{"features": [Size([1, 16, 8, 8])]}],
...     original_in_shape=Size([3, 32, 32]),
... )
>>> head(torch.zeros(1, 16, 8, 8)).shape
torch.Size([1, 3, 32, 32])
```

参数

 * `inputs` (`Tensor`): 形状为 `[B, C, H/s, W/s]` 的特征图。

返回

 * `Tensor`: 形状为 `[B, n_classes, H, W]` 的 logits。当 `s < 1` 时，logits 保持特征图的大小，`[B, n_classes, H/s,
   W/s]`。[BaseNode.run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
   将它们放在 `"segmentation"` 键下。

##### 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)
   不适合大小时。

##### in_height

附加输入的高度。

它是
[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)
   不适合大小时。

##### in_width

附加输入的宽度。

它是
[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
