# bisenet_head

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

BiSeNet 分割头。

## 类

### BiSeNetHead

BiSeNet 分割头。

 * `输入:`: * `inputs` (`Tensor`): [B, C, H ⁄ s, W ⁄ s]
 * `输出:`: * `segmentation` (`Tensor`): [B, nclasses, H, W] logits

> **参考文献**
> * 来源：重新实现了 [BiSeNet: Bilateral Segmentation Network for Real-time Semantic Segmentation](https://arxiv.org/abs/1808.00897)。
 * 许可证：Apache-2.0 (本项目)

> **注意事项**
> H 和 W 是模型输入的高度和宽度。比例 s 是一个 2 的幂，头部根据输入大小和模型输入大小计算得出。头部应用一个 3x3 [luxonis_train.nodes.blocks.ConvBlock](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/blocks/blocks.md)，带有批归一化和 ReLU，以及一个 1x1 卷积，输出通道数为 nclasses⋅s2。然后，一个因子为 s 的 `torch.nn.PixelShuffle` 给出 logits。`forward` 不检查模式，因此导出模式也给出 logits。

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

> **另请参阅**
> [BiseNetv1 仓库](https://github.com/taveraantonio/BiseNetv1)

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

```yaml
- name: BiSeNetHead
  inputs: [ContextSpatial]
```

 * `兼容:`: * 附加索引：`-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__(intermediate_channels: int = 64, **kwargs):
```

构建卷积和像素混洗上采样。

构造函数计算比例 s =
2n。[infer_upscale_factor](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/general.md)
根据输入大小和模型输入大小给出 n。当高度比或宽度比不是 2 的幂，或者两个比率不同时，该函数会引发 `ValueError`。

参数

 * `intermediate_channels` (`int`): 3x3 卷积的输出通道数。
 * `**kwargs`:
   [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。

> **示例**
> ```pycon
>>> import torch
>>> from torch import Size
>>> from luxonis_train.nodes import BiSeNetHead
>>> head = BiSeNetHead(
...     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。[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`: 附加的元数据键及其值。

#### 属性

##### conv_1x1

##### conv_3x3

##### 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

##### upscale
