luxonis_ml.data.utils.cli_utils

module documentation

Undocumented

Function check_exists Ensure that a dataset exists in the selected storage.
Function complete_dataset_name Undocumented
Function get_dataset_info Undocumented
Function parse_split_ratio Parse a CLI split-ratio argument.
Function print_info Undocumented
def check_exists(name: str, bucket_storage: BucketStorage):

Ensure that a dataset exists in the selected storage.

Parameters
name:strDataset name.
bucket_storage:BucketStorageStorage backend to query.
Raises
typer.ExitIf the dataset does not exist.
def complete_dataset_name(incomplete: str) -> list[str]:

Undocumented

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

Undocumented

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

>>> 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.
Parameters
value:str | NoneA string representation of a list of 3 values (train, val, test).
train:float | NoneOptional float or int for training split.
val:float | NoneOptional float or int for validation split.
test:float | NoneOptional float or int for test split.
Returns
dict[str, float | int] | NoneA dictionary with keys "train", "val", and "test" mapping to their respective ratios or counts, or None if no values were provided.
Raises
ValueErrorIf the input format is invalid, if ratios don't sum to 1.0,
or if there's a mix of counts and ratios.
def print_info(dataset: LuxonisDataset):

Undocumented