luxonis_ml.data.datasets.Metadata

class documentation

class Metadata(BaseModelExtraForbid):

Stored metadata for a Luxonis Data Format dataset.

Method	`merge_with`	Merge two metadata objects together.
Method	`set_classes`	Undocumented
Instance Variable	`categorical_encodings`	Integer encodings for categorical metadata.
Instance Variable	`classes`	Class-index mappings per task.
Instance Variable	`ldf_version`	Luxonis Data Format version.
Instance Variable	`metadata_types`	Metadata value types per metadata task.
Instance Variable	`parent_dataset`	Optional identifier of the source dataset this dataset was derived from.
Instance Variable	`skeletons`	Keypoint skeleton definitions per task.
Instance Variable	`source`	Dataset source description.
Instance Variable	`tasks`	Task types per task name.
Method	`_sort_classes`	Undocumented

def merge_with(self, other: Metadata) -> Metadata: ¶

Merge two metadata objects together.

Parameters
other:`Metadata`	Metadata object to merge into this one.

Returns
`Metadata`	New metadata object containing merged classes, tasks, skeletons, categorical encodings, metadata types, and source information.

Raises
`ValueError`	If the two metadata objects use different LDF versions.

def set_classes(self, classes: list[str] | dict[str, int], task: str): ¶

Undocumented

categorical_encodings: dict[str, dict[str, int]] = ¶

Integer encodings for categorical metadata.

classes: dict[str, dict[str, int]] = ¶

Class-index mappings per task.

ldf_version: str = ¶

Luxonis Data Format version.

metadata_types: dict[str, Literal['float', 'int', 'str', 'Category']] = ¶

Metadata value types per metadata task.

parent_dataset: str | None = ¶

Optional identifier of the source dataset this dataset was derived from.

skeletons: dict[str, Skeletons] = ¶

Keypoint skeleton definitions per task.

source: LuxonisSource | None = ¶

Dataset source description.

tasks: dict[str, list[str]] = ¶

Task types per task name.

def _sort_classes(self, classes: Iterable[str]) -> list[str]: ¶

Undocumented