# typing

Python API: `luxonis_ml.typing`

用于类型检查的常用类型别名和实用函数。

## 类

### BaseModelExtraForbid

禁止额外字段的基础模型。

#### 属性

##### model_config

Pydantic 模型配置，`extra` 设置为 `"forbid"`。

### ConfigItem

用于动态对象实例化的配置模式。通常用于实例化存储在注册表中的对象。

一个包含名称和参数字典的字典。

> **示例**
> ```pycon
>>> ConfigItem(name="Resize", params={"height": 256}).name
'Resize'
>>> ConfigItem(name="Normalize").params
{}
```

#### 属性

##### name

此配置适用的对象名称。

##### params

实例化对象的附加参数。

### LoaderOutput

数据集加载器返回的图像、标签和记录元数据。

新代码优先使用属性访问。该对象还支持传统的两值元组协议，因此现有代码可以继续解包 `image_or_images, labels = loader[0]`。

> **示例**
> ```python
sample = loader[0]

images = sample.images
labels = sample.labels
metadata = sample.metadata
```

#### 属性

##### image

返回图像字典中的第一个图像。

##### images

按源名称键入的图像数组。单源数据集使用常规的 `"image"` 键。

##### labels

按 `"task_name/task_type"` 键入的标签数组。

##### metadata

来自
[DatasetRecord.sample_metadata](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/ldf/annotation.md)
的记录级元数据，以及任何自动加载器元数据，例如启用时的 `"filenames"`。增强输出还包括一个从配置路径到所选运行时参数的 `"augmentations"` 映射。

### TrackedAugmentations

加载器生成的增强来源。

一个普通的映射，仅为了与记录自己的 `"augmentations"` 元数据区分开而子类化。

## 函数

### all_not_none

```python
def all_not_none(values: Iterable[Any]) -> bool:
```

检查集合中的所有值是否都不为 `None`。

> **示例**
> ```pycon
>>> all_not_none([1, "x", 0])
True
>>> all_not_none([1, None, 0])
False
>>> all_not_none([])
True
```

参数

 * `values` (`Iterable[Any]`): 要检查的值的可迭代对象。

返回

 * `bool`: 如果所有值都不为 `None`，则为 `True`，否则为 `False`。

### any_not_none

```python
def any_not_none(values: Iterable[Any]) -> bool:
```

检查集合中是否至少有一个值不为 `None`。

> **示例**
> ```pycon
>>> any_not_none([None, "x"])
True
>>> any_not_none([None, None])
False
>>> any_not_none([])
False
```

参数

 * `values` (`Iterable[Any]`): 要检查的值的可迭代对象。

返回

 * `bool`: 如果至少有一个值不为 `None`，则为 `True`，否则为 `False`。

### check_type

```python
def check_type(value: Any, typ: type[T]) -> TypeGuard[T]:
```

检查值是否具有预期类型。

> **注意**
> 此函数充当 [类型保护](https://typing.python.org/en/latest/spec/narrowing.html#typeguard)，允许类型检查器在函数返回 `True` 时缩小变量的类型。

> **示例**
> ```pycon
>>> check_type("oak", str)
True
>>> check_type("oak", int)
False
>>> check_type([1, 2, 3], list)
True
```

参数

 * `value` (`Any`): 要检查的值。
 * `typ` (`type[T]`): 要检查的类型。

返回

 * `TypeGuard[T]`: 如果 `value` 符合 `typ`，则为 `True`，否则为 `False`。

## 属性

### Color

颜色类型别名。

可以是字符串（例如“red”、“#FF5512”）、RGB 值元组或单个值（在这种情况下，它被解释为灰度值）。

### HSV

### Kwargs

任意参数的关键字字典。

### Labels

将任务名称映射到 C{np.ndarray} 形式的注释的字典

### LoaderMultiOutput

C{LoaderMultiOutput} 是一个元组，包含一个将图像名称映射到 C{np.ndarray} 的字典，以及一个包含任务组名称及其 L{Labels} 形式注释的字典。

### LoaderSingleOutput

C{LoaderSingleOutput} 是一个元组，包含一个 C{np.ndarray} 形式的单个图像，以及一个包含任务组名称及其 L{Labels} 形式注释的字典。

### Params

附加参数的关键字字典。

通常从 YAML 文件加载。

### ParamValue

### PathType

字符串或 [pathlib.Path](https://docs.python.org/3/library/pathlib.html#pathlib.Path) 对象。

### PosixPathType

字符串或 [pathlib.PurePosixPath](https://docs.python.org/3/library/pathlib.html#pathlib.PurePosixPath) 对象。

### PrimitiveType

Python 中的原始类型。

### RGB

### T

### TaskType
