deepcave.utils.configs

# Configs

This module provides a utility for parsing the configurations from a filename.

Functions

parse_config([filename])

Parse the config given the filename.
deepcave.utils.configs.parse_config(filename=None)[source]

Parse the config given the filename.

Both relative and absolute paths are possible.

Parameters:

filename (Optional[str], optional) – Location of the config. Must be a python file. By default None (default configuration will be used).

Note

The python file must contain a class named Config and inherit deepcave.config.Config.

Returns:

Either the default config (if no filename is given) or the config parsed from the given filename.

Return type:

Config

Raises:

RuntimeError – If config class could not be loaded.

previous

deepcave.utils.compression

next

deepcave.utils.configspace