# base_head

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

所有头的基类。

头是具有任务和导出解析器的节点。任务决定了哪些损失、指标和可视化工具可以附加到头。解析器名称与头的类名一起进入 NN Archive。

## 类

### BaseHead

模型中所有头的基类。

子类设置 `task` 类属性。带有导出解析器的子类还设置 `parser` 类属性。子类可以重写
[get_custom_head_config](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/base_head.md)
以向其解析器提供更多值，并重写
[annotate](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/base_head.md)
以支持默认注释不支持的任务。

#### 方法

##### annotate

```python
def annotate(head_output: Packet[Tensor], image_paths: list[Path], config_preprocessing: PreprocessingConfig) -> DatasetIterator:
```

将头的输出转换为数据集记录。

这委托给
[luxonis_train.utils.annotation.default_annotate](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/annotation.md)。对于默认转换器不支持的任务，请重写它。

参数

 * `head_output` (`Packet[Tensor]`): 一个批次的头输出包。
 * `image_paths` (`list[Path]`): 原始图像的路径，按批次顺序排列。
 * `config_preprocessing` (`PreprocessingConfig`): 用于将预测映射回图像的预处理设置。

返回

 * `DatasetIterator`: 注释记录的生成器。

##### 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`: 附加的元数据键及其值。

##### get_head_config

```python
def get_head_config(self) -> dict[str, Any]:
```

返回 NN Archive 配置中头的条目。

该方法从 `parser`
类属性、[BaseNode.class_names](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
和头的
[BaseNode.n_classes](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
开始。然后它将
[get_custom_head_config](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/base_head.md)
的结果合并到 `"metadata"`
字典中。自定义键替换同名的基本键。[LuxonisModel.archive](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/core/core.md)
为每个 `remove_on_export` 为 `False` 的头调用此方法。然后它添加 `"name"` 和 `"outputs"` 键。

类名始终来自
`dataset_metadata`。如果没有它，[BaseNode.class_names](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
会引发 `RuntimeError`。当数据集中没有名为 `task_name` 的任务时，它会引发 `ValueError`。

> **示例**
> ```pycon
>>> from torch import Size
>>> from luxonis_train.nodes import ClassificationHead
>>> from luxonis_train.utils import DatasetMetadata
>>> head = ClassificationHead(
...     task_name="animals",
...     dataset_metadata=DatasetMetadata(
...         classes={"animals": {"cat": 0, "dog": 1}}
...     ),
...     input_shapes=[{"features": [Size([1, 8, 4, 4])]}],
... )
>>> head.get_head_config()
{'parser': 'ClassificationParser',
 'metadata': {'classes': ['cat', 'dog'], 'n_classes': 2,
              'is_softmax': False}}
```

返回

 * `dict[str, Any]`: 包含键 `"parser"` 和 `"metadata"` 的字典。`"metadata"` 字典包含 `"classes"`、`"n_classes"` 和自定义键。

#### 属性

##### parser

在导出的模型中读取头输出的解析器名称。[get_head_config](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/base_head.md) 将其放入头的 NN Archive 条目中。在基类中，它为 `""`。

##### task

头的任务。它提供主输出的键和头所需的标签。
