# annotation

Python API: `luxonis_train.utils.annotation`

将模型的预测转换为数据集注释。

## 函数

### default_annotate

```python
def default_annotate(head: lxt.nodes.BaseHead, head_output: Packet[Tensor], image_paths: list[Path], config_preprocessing: PreprocessingConfig) -> DatasetIterator:
```

将一个批次的头部输出转换为数据集记录。

[BaseHead.annotate](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/base_head.md)
返回此生成器。它支持标签 `"boundingbox"`、`"keypoints"`、`"instance_segmentation"`、`"segmentation"`、`"classification"` 和 `"text"`。它读取
`head.task` 所需的每个标签的条目。

对于每个图像，生成器读取图像文件以获取原始大小。[transform_boxes](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/spatial_transforms.md)、[transform_keypoints](https://docs.luxonis.com/zh/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/spatial_transforms.md)
和
[transform_masks](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/spatial_transforms.md)
将预测映射到原始图像。每条记录都有键 `"file"`、`"task_name"` 和 `"annotation"`。`"annotation"` 条目取决于标签：

 * `"boundingbox"`：每个框一条记录，包含 `"instance_id"`、类名以及归一化的 `x`、`y`、`w` 和 `h`。预测的第 `0` 到 `3` 列包含 `xyxy` 框，第 `5` 列包含类索引。
 * `"keypoints"`：每个实例一条记录，包含 `"instance_id"` 和 `(x, y, visibility)` 元组。可见性是预测的第三个值，经过四舍五入。
 * `"instance_segmentation"`：每个实例一条记录，包含 `"instance_id"` 和原始大小的掩码。当调整大小后的预测不为零时，掩码为 `True`。
 * `"segmentation"`：每个类一条记录，包含类名和来自
   [seg_output_to_bool](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/utils/segmentation.md)
   的掩码。
 * `"classification"`：一条记录，包含得分最高的类。
 * `"text"`：一条记录，包含 `"metadata"` 条目。其 `"text"` 键包含 `head.decoder` 从 `"ocr"` 条目读取的文本。

当除 `"text"` 之外的每个所需标签都没有图像预测时，生成器会生成一条仅包含 `"file"` 键的记录。仅需要 `"text"` 的任务永远不会生成此类记录。生成器在迭代期间引发错误，而不是在调用时引发。

警告： 如果没有 `keep_aspect_ratio`，生成器不会缩放 `train_image_size` 中的框和关键点坐标。当原始大小与它不同时，坐标是错误的。

参数

 * `head` (`lxt.nodes.BaseHead`)：进行预测的头部。生成器读取其 `task`、`task_name`、`classes` 和 `name`。对于 `"text"` 标签，它还读取 `decoder`。
 * `head_output` (`Packet[Tensor]`)：头部的输出包。每个标签的条目为每个图像包含一个元素。`"text"` 标签读取 `"ocr"` 条目。
 * `image_paths` (`list[Path]`)：原始图像的路径，按批次顺序排列。
 * `config_preprocessing` (`PreprocessingConfig`)：预处理配置。生成器读取 `train_image_size` 和 `keep_aspect_ratio`。

返回

 * `DatasetIterator`

生成

 * `luxonis_ml` 记录格式的一条记录。

引发

 * `ValueError`：当 `head.task` 需要生成器不支持的标签时，或者当没有 `decoder` 的头部需要 `"text"` 标签时。
 * `FileNotFoundError`：当 OpenCV 无法读取图像时。

## 属性

### ALLOWED_ANNOTATE_LABELS
