mml.core.data_loading.task_description

class TaskDescription

Bases: object

A task description holding the meta information on task background as well as the actual links to samples.

__init__(name: str | None = None, description: str = '', creation_protocol: str = '', reference: str = '', url: str = '', download: str = '', license: ~mml.core.data_loading.task_attributes.License = License.UNKNOWN, release: str = '', task_type: ~mml.core.data_loading.task_attributes.TaskType = TaskType.UNKNOWN, keywords: ~typing.List[~mml.core.data_loading.task_attributes.Keyword] = <factory>, means: ~mml.core.data_loading.task_attributes.RGBInfo = <factory>, stds: ~mml.core.data_loading.task_attributes.RGBInfo = <factory>, sizes: ~mml.core.data_loading.task_attributes.Sizes = <factory>, modalities: ~typing.Dict[~mml.core.data_loading.task_attributes.Modality, str] = <factory>, idx_to_class: ~typing.Dict[int, str] = <factory>, class_occ: ~typing.Dict[str, int] = <factory>, unlabeled_samples: ~typing.Dict[str, ~typing.Dict[~mml.core.data_loading.task_attributes.Modality, int | ~typing.List[int] | ~typing.List[float] | str]] = <factory>, train_folds: ~typing.List[~typing.List[str]] = <factory>, train_samples: ~typing.Dict[str, ~typing.Dict[~mml.core.data_loading.task_attributes.Modality, int | ~typing.List[int] | ~typing.List[float] | str]] = <factory>, test_samples: ~typing.Dict[str, ~typing.Dict[~mml.core.data_loading.task_attributes.Modality, int | ~typing.List[int] | ~typing.List[float] | str]] = <factory>) → None

class_occ: Dict[str, int]

creation_protocol: str = ''

description: str = ''

download: str = ''

classmethod from_json(data_dict: Dict[str, Any]) → TaskDescription

Counterpart for the to_json function: Replaces enum values with their entities and creates a TaskDescription.

Parameters:

data_dict (Dict[str, Any]) – a dictionary without any custom classes as values to be saved in json format.

Returns:

a TaskDescription with entries as encoded in the data_dict

idx_to_class: Dict[int, str]

keywords: List[Keyword]

license: License = 'unknown'

means: RGBInfo

modalities: Dict[Modality, str]

name: str | None = None

property num_samples: int

The number or training (or unlabeled) samples.

reference: str = ''

release: str = ''

sizes: Sizes

stds: RGBInfo

task_type: TaskType = 'unknown'

test_samples: Dict[str, Dict[Modality, int | List[int] | List[float] | str]]

to_json() → Dict[str, Any]

Helper to transform a TaskDescription into a json compatible dict.

Returns:

(dic) A dictionary without any custom classes as values to be saved in json format.

train_folds: List[List[str]]

train_samples: Dict[str, Dict[Modality, int | List[int] | List[float] | str]]

unlabeled_samples: Dict[str, Dict[Modality, int | List[int] | List[float] | str]]

url: str = ''