# base_engine

Python API: `luxonis_ml.data.augmentations.base_engine`

## 类

### AugmentationEngine

#### 方法

##### init

```python
def __init__(height: int, width: int, targets: Mapping[str, str], n_classes: Mapping[str, int], source_names: list[str], config: Iterable[Params], keep_aspect_ratio: bool, is_validation_pipeline: bool | None = None, pipeline_stage: Literal['train', 'val', 'test'] | None = None, min_bbox_visibility: float = 0.0, seed: int | None = None, bbox_area_threshold: float = 0.0004):
```

从配置初始化增强管道。

参数

 * `height` (`int`): 目标图像高度。
 * `width` (`int`): 目标图像宽度。
 * `targets` (`Mapping[str, str]`): 任务名称映射到任务类型，例如 `{"detection/boundingbox": "bbox"}`。
 * `n_classes` (`Mapping[str, int]`): 每个任务关联的类数量，例如 `{"cars/boundingbox": 2}`。
 * `source_names` (`list[str]`): 加载器图像中预期的源名称。
 * `config` (`Iterable[Params]`): 增强配置。每个项目描述一个增强；解释是引擎特定的。
 * `keep_aspect_ratio` (`bool`): 调整大小时是否保留图像纵横比。
 * `is_validation_pipeline` (`bool | None`): 可选的向后兼容的训练与评估提示。> **已弃用**
   > 自 0.5.0 版本起已弃用：请改用 `pipeline_stage`。
 * `pipeline_stage` (`Literal['train', 'val', 'test'] | None`): 可选的显式管道阶段。如果提供，它将优先于 `is_validation_pipeline`。
 * `min_bbox_visibility` (`float`): 增强后必须保持可见的原始边界框的最小部分。
 * `seed` (`int | None`): 可选的随机种子，用于可重现的增强。
 * `bbox_area_threshold` (`float`): 边界框保持有效的最小归一化面积。默认值会移除非常小的框及其关联的关键点。

##### apply

```python
def apply(input_batch: list[LoaderMultiOutput]) -> LoaderMultiOutput:
```

将增强管道应用于数据。

参数

 * `input_batch` (`list[LoaderMultiOutput]`): 要增强的加载器输出。项目数量必须与引擎的批处理大小匹配。

返回

 * `LoaderMultiOutput`: 增强的加载器输出。

#### 属性

##### applied_augmentations

按配置的增强路径键入的运行时参数。

描述最新的
[apply](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/base_engine.md)
调用；没有出处跟踪的引擎返回一个空字典。调用者将映射与它描述的样本一起保存，因此它不能在多次调用中重复使用。

##### batch_augmentation_indices

贡献到上次增强输出的输入位置。

不公开此信息的引擎假定使用每个输入位置，从而保留现有批处理引擎的行为。

##### batch_size

增强管道所需的批处理大小。

批处理大小是批处理增强情况下增强管道请求的图像数量。

例如，如果增强管道包含 MixUp 增强，则批处理大小应为 2。

如果管道需要 MixUp 和 Mosaic4 增强，则批处理大小应为 8 = (2⋅4)。

## 属性

### AUGMENTATION_ENGINES

增强引擎的注册表。
