create_config_template

gaitmap_challenges.config.create_config_template(path: ~typing.Union[str, ~pathlib.Path], _config_type: ~typing.Type[~gaitmap_challenges.config._ConfigT] = <class 'gaitmap_challenges.config.LocalConfig'>)

Create a template json file that can be used to configure the datasets paths.

Use that method once to create your local config file.

Then you can use set_config(path_to_config) to set the global config to your local config file.

Parameters:

pathUnion[str, Path]

The path to the file where the config should be created.

_config_typeType[_ConfigT], optional

In case you have a custom config structure, you can pass it here, by default LocalConfig. Note, that we don’t support arbitrary config structures. So this should be considered an internal parameter with no real use outside gaitmap-challenges/bench or some custom higher-level package that you build.