# luxonis_parser

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

## 类

### LuxonisParser

检测数据集格式并分派给匹配的解析器。

解析器接受本地路径、[LuxonisFileSystem](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/filesystem.md)
支持的远程路径、ZIP 存档和 `roboflow://workspace/project/version/format` 形式的 Roboflow 数据集 URL。如果省略
`dataset_type`，则会尝试解析器，直到其中一个将数据集目录验证为完整目录或单个拆分。

#### 方法

##### init

```python
def __init__(dataset_dir: str, *, dataset_name: str | None = None, save_dir: Path | str | None = None, dataset_plugin: T = None, dataset_type: DatasetType | None = None, task_name: str | dict[str, str] | None = None, full_warnings: bool = False, **kwargs):
```

各种解析器的高级抽象。

自动识别数据集格式并使用适当的解析器。

参数

 * `dataset_dir` (`str`): 数据集目录标识符。可以是以下之一： * 数据集目录的本地路径。
    * * `L{LuxonisFileSystem} 支持的远程 URL。`: * `gcs://` 或 `gs://` 用于 Google Cloud Storage
          * `s3://` 用于 Amazon S3
    * * `roboflow://` 用于 Roboflow 数据集。`: * 预期格式：`roboflow://workspace/project/version/format`。
    * * `ultralytics://` 用于 Ultralytics Platform 数据集。`: * 预期格式：`ultralytics://username/datasets/slug`
          * 可选版本：附加 `?v=<version>` 以导出特定数据集版本。
 * `dataset_name` (`str | None`): 可选的输出数据集名称。如果省略，则名称从 `dataset_dir` 派生。
 * `save_dir` (`Path | str | None`): 下载远程数据集时使用的可选目录。如果省略，则使用当前工作目录。
 * `dataset_plugin` (`T`): 可选的数据集插件注册表名称。如果省略，则使用 `LuxonisDataset`。
 * `dataset_type` (`DatasetType | None`): 可选的数据集类型。如果提供，则跳过自动格式识别。
 * `task_name` (`str | dict[str, str] | None`): 可选的任务命名规则。字符串用于所有记录。映射使用类名作为键，任务名作为值。
 * `full_warnings` (`bool`): 是否应记录所有跳过的注释警告而不截断。
 * `**kwargs`: 传递给所选数据集构造函数的附加参数。

引发

 * `RuntimeError`: 如果使用了 Roboflow URL 且未配置 `ROBOFLOW_API_KEY`。
 * `ValueError`: 如果 Roboflow URL 格式错误，其版本不是整数，或者无法识别数据集格式。

##### get_parser_issue_messages

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

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

##### parse

```python
def parse(**kwargs) -> BaseDataset:
```

解析数据集并以 LDF 格式返回。

如果数据集已存在，则将跳过解析并返回现有数据集。

> **注意**
> 当解析器读取单个拆分时，此方法会将 `random_split=True`，除非您传递自己的值。这与 [BaseParser.parse_split](/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/parsers/base_parser.md) 不同，后者声明 `random_split=False`。因此，单个拆分默认获得随机的训练、验证和测试拆分。

参数

 * `**kwargs`: 特定于解析器的参数。

返回

 * `BaseDataset`: 解析后的数据集。

引发

 * `ValueError`: 如果所选解析器拒绝数据集结构或拆分参数。

### ParserType

识别的解析器入口点类型。

#### 属性

##### DIR

具有多个拆分的数据集目录。

##### SPLIT

表示一个解析器输入拆分的目录或文件。

## 属性

### T
