# base_parser

Python API: `luxonis_ml.data.parsers.base_parser`

## 类

### BaseParser

数据集格式解析器的基类。

#### 方法

##### init

```python
def __init__(dataset: BaseDataset, dataset_type: DatasetType, task_name: str | dict[str, str] | None, full_warnings: bool = False):
```

为目标数据集创建解析器。

参数

 * `dataset` (`BaseDataset`): 要填充解析记录的数据集。
 * `dataset_type` (`DatasetType`): 源数据集格式。
 * `task_name` (`str | dict[str, str] | None`): 可选的任务命名规则。字符串用于所有记录。映射使用类名作为键，任务名作为值。
 * `full_warnings` (`bool`): 是否记录每个跳过的注释警告。当为 `False` 时，只记录前 50 个警告，其余的进行汇总。

##### discover_dir_splits

```python
def discover_dir_splits(dataset_dir: Path) -> dict[str, dict[str, Any]]:
```

返回按其规范拆分名称键入的现有且有效的拆分目录。

##### from_dir

```python
def from_dir(dataset_dir: Path, **kwargs) -> tuple[list[Path], list[Path], list[Path]]:
```

解析源数据集目录中的所有数据。

参数

 * `dataset_dir` (`Path`): 源数据集目录。
 * `**kwargs`: 额外的解析器特定参数。

返回

 * `tuple[list[Path], list[Path], list[Path]]`: 训练、验证和测试拆分中添加的图像。

##### from_split

```python
def from_split(**kwargs) -> ParserOutput:
```

从一个拆分子目录解析数据。

> **示例**
> ```python
split_kwargs = parser.validate_split(split_path)
if split_kwargs is not None:
    parser.from_split(**split_kwargs)
```

参数

 * `**kwargs`: 解析器特定参数，通常由 `validate_split` 生成。

返回

 * `ParserOutput`: LDF 生成器、骨架元数据和添加的图像。

##### get_parser_issue_messages

```python
def get_parser_issue_messages(self) -> list[ParserIssueMessage]:
```

返回上次解析期间收集的解析器问题消息。

##### parse_dir

```python
def parse_dir(dataset_dir: Path, **kwargs) -> BaseDataset:
```

将整个数据集目录解析到目标数据集中。

参数

 * `dataset_dir` (`Path`): 源数据集目录。
 * `**kwargs`: 解析器特定参数。

返回

 * `BaseDataset`: 包含解析图像和注释的数据集。

引发

 * `ValueError`: 如果期望顶级拆分的解析器找不到 `train` 目录。

##### parse_split

```python
def parse_split(split: str | None = None, random_split: bool = False, split_ratios: dict[str, float | int] | None = None,
**kwargs) -> BaseDataset:
```

将一个拆分子目录解析到目标数据集中。

参数

 * `split` (`str | None`): 可选的拆分名称，用于分配给解析数据。设置后，`split_ratios` 和 `random_split` 将被忽略。
 * `random_split` (`bool`): 是否使用 `split_ratios` 生成随机拆分。
 * `split_ratios` (`dict[str, float | int] | None`): 可选的比例或计数。浮点值被视为比例；整数值被视为计数。
 * `**kwargs`: 解析器特定参数。

返回

 * `BaseDataset`: 包含解析图像和注释的数据集。

##### reset_parser_issue_messages

```python
def reset_parser_issue_messages(self):
```

清除收集的解析器问题消息。

##### validate

```python
def validate(dataset_dir: Path) -> bool:
```

验证数据集目录是否具有预期格式。

参数

 * `dataset_dir` (`Path`): 源数据集目录。

返回

 * `bool`: 数据集是否为预期格式。

##### validate_split

```python
def validate_split(split_path: Path) -> dict[str, Any] | None:
```

验证拆分目录是否具有预期格式。

参数

 * `split_path` (`Path`): 拆分目录的路径。

返回

 * `dict[str, Any] | None`: `from_split` 的关键字参数，如果拆分不是预期格式，则为 `None`。

## 属性

### ParserOutput
