torchsig.datasets.default_configs.loader.get_default_yaml_config

torchsig.datasets.default_configs.loader.get_default_yaml_config(dataset_type: str, impairment_level: bool | int, train: bool, ret_config_path: bool = False) → dict[source]

Loads the default YAML configuration for a given dataset type, impairment level, and training/validation status.

This function constructs the path to the appropriate YAML configuration file based on the dataset type, impairment level, and whether the dataset is for training or validation. It then loads the YAML file and returns its contents as a dictionary.

Parameters:

  • dataset_type (str) – The type of dataset to load the configuration for. Should be either ‘narrowband’ or ‘wideband’.

  • impairment_level (bool | int) – The impairment level for the dataset: - 0 or False for ‘clean’ data, - 2 or True for ‘impaired’ data.

  • train (bool) – Whether the dataset is for training (True) or validation (False).

  • ret_config_path (bool, optional) – If True, the function also returns the path to the configuration file. Defaults to False.

Returns:

The parsed dataset metadata from the YAML configuration file. If ret_config_path is True, returns a tuple of the dataset metadata and the configuration file path.

Return type:

dict

Raises:

ValueError – If the dataset_type is not one of “narrowband” or “wideband”, or if the impairment level is invalid or 1.

Example

# Load the default configuration for a clean narrowband dataset for training config = get_default_yaml_config(‘narrowband’, 0, True)

# Load the default configuration for an impaired wideband dataset for validation and get the config path config, path = get_default_yaml_config(‘wideband’, 2, False, ret_config_path=True)