gaitmap_datasets.set_config#

gaitmap_datasets.set_config(config_obj_or_path: Union[str, Path, DatasetsConfig] = PosixPath('/home/arne/Documents/repos/private/gaitmap-datasets/.datasets.dev.json'))[source]#

Set the global config object containing configured paths for the datasets.

This allows you to set a global configuration that is automatically used by the dataset classes. It allows you to load the datasets without explicitly passing the path to the dataset.

Note, that you have to call this function before you initialize any dataset class. If you want to change the config during runtime, you can use the reset_config function and then call set_config again, or get the config (config()) and change the attributes of the config object.

Parameters:
config_obj_or_path

You can either pass a valid config object or a path to a config file. To create a config file, you can use the create_config_file function.