# voc_parser

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

## Classes

### VOCParser

Parse a directory with VOC annotations into LDF.

Expected format:

```text
dataset_dir/
├── train/
│   ├── img1.jpg
│   ├── img1.xml
│   └── ...
├── valid/
└── test/
```

This is one of the formats that Roboflow can generate.

#### Methods

##### from_dir

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

Parse all data in a source dataset directory.

Parameters

 * `dataset_dir` (`Path`): Source dataset directory.
 * `**kwargs`: Additional parser-specific arguments.

Returns

 * `tuple[list[Path], list[Path], list[Path]]`: Added images for the train, validation, and test splits.

##### from_split

```python
def from_split(image_dir: Path, annotation_dir: Path) -> ParserOutput:
```

Parse VOC annotations into LDF records.

Annotations include classification and object detection.

Parameters

 * `image_dir` (`Path`): Directory with images.
 * `annotation_dir` (`Path`): Directory with `.xml` annotations.

Returns

 * `ParserOutput`: Parser output containing annotation records, skeleton metadata, and added images.

Raises

 * `ValueError`: If an annotation XML file cannot be parsed or a required XML tag is missing.

##### validate_split

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

Validate whether a split directory has the expected format.

Parameters

 * `split_path` (`Path`): Path to a split directory.

Returns

 * `dict[str, Any] | None`: Keyword arguments for `from_split`, or `None` if the split is not in the expected format.