# cli_utils

Python API: `luxonis_ml.data.utils.cli_utils`

## Functions

| Name | Description |
| --- | --- |
|
[`check_exists`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/cli_utils.md)
| Ensure that a dataset exists in the selected storage. |
|
[`complete_dataset_name`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/cli_utils.md)
| |
|
[`get_dataset_info`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/cli_utils.md)
| |
|
[`get_tracked_augmentations`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/cli_utils.md)
| Read the augmentation provenance the loader added to a sample. |
|
[`parse_split_ratio`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/cli_utils.md)
| Parse a CLI split-ratio argument. |
|
[`print_info`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/utils/cli_utils.md)
| |

### function `check_exists`

```python
def check_exists(name: str, bucket_storage: BucketStorage)
```

Ensure that a dataset exists in the selected storage.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `name` | `str` | Dataset name. | required |
| `bucket_storage` | `BucketStorage` | Storage backend to query. | required |

Raises

| Type | Description |
| --- | --- |
| `typer.Exit` | If the dataset does not exist. |

### function `complete_dataset_name`

```python
def complete_dataset_name(incomplete: str) -> list[str]
```

### function `get_dataset_info`

```python
def get_dataset_info(dataset: LuxonisDataset) -> tuple[set[str], list[str]]
```

### function `get_tracked_augmentations`

```python
def get_tracked_augmentations(metadata: Params) -> TrackedAugmentations | None
```

Read the augmentation provenance the loader added to a sample.

A record can store its own `"augmentations"` metadata, which the loader keeps instead. The marker type tells the two apart; the
shape alone does not.

### function `parse_split_ratio`

```python
def parse_split_ratio(
    value: str | None = None,
    train: float | None = None,
    val: float | None = None,
    test: float | None = None,
) -> dict[str, float | int] | None
```

Parse a CLI split-ratio argument.

Float lists represent ratios and must sum to 1.0. Integer lists represent absolute counts.

> **Example**
> ```pycon
>>> parse_split_ratio("[0.7, 0.2, 0.1]")
{'train': 0.7, 'val': 0.2, 'test': 0.1}
>>> parse_split_ratio(train=70, val=20, test=10)
{'train': 70, 'val': 20, 'test': 10}
>>> parse_split_ratio(train=0.7, val=0.2)
{'train': 0.7, 'val': 0.2, 'test': 0.1}
>>> parse_split_ratio(train=0.7, val=0.2, test=0.1)
{'train': 0.7, 'val': 0.2, 'test': 0.1}
>>> parse_split_ratio([10, 27])
Traceback (most recent call last):
...
ValueError: Split ratio must be a list of 3 values (train, val, test).
>>> parse_split_ratio(train=0.7, val=0.2, test=0.2)
Traceback (most recent call last):
...
ValueError: Split ratios must sum to 1.0; use whole numbers for counts.
```

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `value` | `str | None` | A string representation of a list of 3 values (train, val, test). | `None` |
| `train` | `float | None` | Optional float or int for training split. | `None` |
| `val` | `float | None` | Optional float or int for validation split. | `None` |
| `test` | `float | None` | Optional float or int for test split. | `None` |

Returns

| Type | Description |
| --- | --- |
| `dict[str, float | int] | None` | A dictionary with keys "train", "val", and "test" mapping to their respective ratios or counts, or None if no values were provided. |

Raises

| Type | Description |
| --- | --- |
| `ValueError` | If the input format is invalid, if ratios don't sum to 1.0, |
| `or if there's a mix of counts and ratios.` |  |

### function `print_info`

```python
def print_info(dataset: LuxonisDataset)
```
