# tasks

Python API: `luxonis_train.tasks`

头部可以解决的任务，以及每个任务所需的标签。

任务将头部连接到附加到它的损失、指标和可视化工具。它给出头部主要预测的键以及加载器必须提供的标签。[Tasks](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
提供每个内置任务的实例。

## 类

### AnomalyDetection

异常检测任务。

其名称为
`"anomaly_detection"`。[LuxonisLoaderPerlinNoise](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/loaders/luxonis_perlin_loader_torch.md)
提供其所有标签。`"segmentation"` 标签是形状为 `[2, H, W]` 的独热异常掩码。`"original_segmentation"` 标签是没有添加异常的输入图像。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### main_output

具有此任务的头部主要预测的键。

除非子类覆盖它，否则它是 `name`。当 `forward`
返回张量或张量列表时，[BaseNode.run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
将结果放在此键下。附加模块从此键填充一些参数。此类参数的名称以 `pred` 开头且没有下划线，例如 `predictions`。

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的数据集任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### BoundingBox

边界框检测任务。

其名称为 `"boundingbox"`。它只需要 `"boundingbox"` 标签。

#### 方法

##### init

```python
def __init__(self):
```

### Classification

分类任务。

其名称和所需标签均为 `"classification"`。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的数据集任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### Embeddings

嵌入任务。

其名称为 `"embeddings"`。它需要整数或分类 `"metadata/id"` 标签。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的数据集任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### Fomo

FOMO 检测任务。

其名称为 `"fomo"`。FOMO 头部预测对象中心的热图。该任务需要 `"boundingbox"` 标签，其主要预测是 `"heatmap"`。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### main_output

具有此任务的头部主要预测的键。

除非子类覆盖它，否则它是 `name`。当 `forward`
返回张量或张量列表时，[BaseNode.run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
将结果放在此键下。附加模块从此键填充一些参数。此类参数的名称以 `pred` 开头且没有下划线，例如 `predictions`。

### InstanceBaseTask

检测对象实例的任务的基类。

子类需要 `"boundingbox"` 标签。一些子类添加更多标签。

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的数据集任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### InstanceKeypoints

对象实例的关键点检测任务。

其名称为 `"keypoints"`。它需要边界框和关键点。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的数据集任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### InstanceSegmentation

实例分割任务。

其名称为 `"instance_segmentation"`。它需要边界框和实例掩码。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的数据集任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### InstanceSegmentationKeypoints

实例分割和关键点检测任务。

其名称为 `"instance_segmentation_keypoints"`。它需要边界框、实例掩码和关键点。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的数据集任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### Keypoints

没有边界框的关键点任务。

其名称为 `"pointcloud"`。与
[InstanceKeypoints](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
不同，它不需要 `"boundingbox"` 标签。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的数据集任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### Metadata

任务所需的元数据标签。

标签的字符串形式是 `"metadata/<name>"`。加载器输出中标签的键是 `"<task_name>/metadata/<name>"`，其中 `<task_name>` 是节点的数据集任务。当 `name` 和 `typ`
相等时，两个标签相等。哈希仅取决于 `name`。

> **示例**
> ```pycon
>>> from luxonis_train.tasks import Metadata
>>> label = Metadata("text", str)
>>> str(label)
'metadata/text'
```

#### 方法

##### check_type

```python
def check_type(typ: UnionType | type) -> bool:
```

检查标签是否接受某种类型的值。

当 `typ` 属性是联合类型时，该方法检查 `typ` 参数是否是联合类型的成员之一。否则，它检查两种类型是否相等。接受类型的子类不匹配。

> **示例**
> ```pycon
>>> from luxonis_train.tasks import Metadata
>>> label = Metadata("id", int | str)
>>> label.check_type(str), label.check_type(float)
(True, False)
>>> Metadata("flag", int).check_type(bool)
False
```

参数

 * `typ` (`UnionType | type`): 要检查的类型，例如数据集中标签的类型。

返回

 * `bool`: 当标签接受 `typ` 时为 `True`。

#### 属性

##### name

元数据标签的名称，例如 `"id"`。节点的配置中的 `metadata_task_override` 字段可以重命名它。

##### typ

标签值必须具有的类型，或接受类型的联合。

### Ocr

光学字符识别任务。

其名称为 `"ocr"`。它需要字符串 `"metadata/text"` 标签。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的datasets任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### Segmentation

语义分割任务。

其名称和所需标签均为 `"segmentation"`。

#### 方法

##### init

```python
def __init__(self):
```

#### 属性

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的datasets任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### staticproperty

在每次属性访问时调用函数的描述符。

[Tasks](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
使用它，以便每次属性访问都返回一个新的任务。

#### 方法

##### init

```python
def __init__(func: Callable):
```

### Task

所有任务的基类。

头部在其 `task` 类属性中设置其任务。损失、指标或可视化工具在其 `supported_tasks` 中列出其支持的任务。当两个任务具有相同的类和相同的 `name` 时，它们相等。

子类必须覆盖
[required_labels](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)。Python
不强制执行此规则，因为 `functools.cached_property` 隐藏了抽象方法。没有覆盖的子类实例将为
[required_labels](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
返回 `None`。

#### 属性

##### main_output

具有此任务的头部主要预测的键。

除非子类覆盖它，否则它是 `name`。当 `forward`
返回张量或张量列表时，[BaseNode.run](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
将结果放在此键下。附加模块从此键填充一些参数。此类参数的名称以 `pred` 开头且没有下划线，例如 `predictions`。

##### name

任务的名称。它是
[main_output](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
的默认值。

##### required_labels

加载器必须为此任务提供的标签。

实现返回一组标签类型，例如 `"boundingbox"` 和
[Metadata](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/tasks.md)
标签。加载器输出中标签的键是 `"<task_name>/<label>"`。`<task_name>` 是节点的datasets任务，而不是任务的 `name`。该属性为每个任务实例计算一次值。

### Tasks

提供每个内置任务实例的命名空间。

每次访问属性都会构建一个新的任务实例。新实例彼此相等，因此 `node.task in supported_tasks` 等测试有效。

> **示例**
> ```pycon
>>> from luxonis_train.tasks import Tasks
>>> task = Tasks.INSTANCE_KEYPOINTS
>>> task.name, task.main_output
('keypoints', 'keypoints')
>>> sorted(task.required_labels)
['boundingbox', 'keypoints']
>>> Tasks.FOMO.main_output
'heatmap'
>>> Tasks.BOUNDINGBOX == Tasks.BOUNDINGBOX
True
```

#### 属性

##### ANOMALY_DETECTION

##### BOUNDINGBOX

##### CLASSIFICATION

##### EMBEDDINGS

##### FOMO

##### INSTANCE_KEYPOINTS

##### INSTANCE_SEGMENTATION

##### INSTANCE_SEGMENTATION_KEYPOINTS

##### KEYPOINTS

##### OCR

##### SEGMENTATION
