Reading a dataset

metatrain.utils.data.get_dataset.get_dataset(options: DictConfig) → Tuple[Dataset, Dict[str, TargetInfo], Dict[str, TargetInfo]]

Gets a dataset given a configuration dictionary.

The system and targets in the dataset are read from one or more files, as specified in options.

Parameters:

options (DictConfig) – the configuration options for the dataset. This configuration dictionary must contain keys for both the systems and targets in the dataset.

Returns:

A tuple containing a Dataset object and a Dict[str, TargetInfo] containing additional information (units, physical quantities, …) on the targets in the dataset

Return type:

Tuple[Dataset, Dict[str, TargetInfo], Dict[str, TargetInfo]]