czbenchmarks.datasets.utils

Functions

load_dataset(→ czbenchmarks.datasets.base.BaseDataset)

Download and instantiate a dataset using Hydra configuration.

list_available_datasets(→ List[str])

Lists all available datasets defined in the datasets.yaml configuration file.

dataset_to_display_name(→ str)

try to map dataset names to more uniform, pretty strings

Module Contents

czbenchmarks.datasets.utils.load_dataset(dataset_name: str, config_path: str | None = None) czbenchmarks.datasets.base.BaseDataset[source]

Download and instantiate a dataset using Hydra configuration.

Parameters:
  • dataset_name – Name of dataset as specified in config

  • config_path – Optional path to config yaml file. If not provided, will use only the package’s default config.

Returns:

Instantiated dataset object

Return type:

BaseDataset

czbenchmarks.datasets.utils.list_available_datasets() List[str][source]

Lists all available datasets defined in the datasets.yaml configuration file.

Returns:

A sorted list of dataset names available in the configuration.

Return type:

list

czbenchmarks.datasets.utils.dataset_to_display_name(dataset_name: str) str[source]

try to map dataset names to more uniform, pretty strings