template.yaecs_config package

Submodules

template.yaecs_config.config module

Project configuration class.

class ProjectConfig(name='main', overwriting_regime='auto-save', config_path_or_dictionary=None, nesting_hierarchy=None, state=None, main_config=None, from_argv=False, do_not_pre_process=False)

Bases: Configuration

Project configuration class.

Should never be called directly by the user. Please use one of the constructors instead (load_config, build_from_configs, build_from_argv), or the utils.make_config convenience function. :type name: str :param name: name for the config or sub-config :type overwriting_regime: str :param overwriting_regime: can be “auto-save” (default, when a param is overwritten it is merged instead and the config is saved automatically if it had been saved previously), “locked” (params can’t be overwritten except using merge explicitly) or “unsafe” (params can be freely overwritten but reproducibility is not guaranteed). :type config_path_or_dictionary: Union[str, dict, None] :param config_path_or_dictionary: path or dictionary to create the config from :type nesting_hierarchy: Optional[List[str]] :param nesting_hierarchy: list containing the names of all the configs in the sub-config chain leading to this config :type state: Optional[List[str]] :param state: processing state used for state tracking and debugging :type main_config: Optional[Configuration] :param main_config: main config corresponding to this sub-config, or None if this config is the main config :type from_argv: bool :param from_argv: whether the config was created with configs passed from the command line arguments :type do_not_pre_process: bool :param do_not_pre_process: if true, pre-processing is deactivated in this initialization :raises ValueError: if the overwriting regime is not valid :return: none

static get_default_config_path()

Return default config.

Return type:

str

parameters_pre_processing()

Pre-processing on some config parameters.

Return type:

dict

parameters_post_processing()

Post-processing on some config parameters.

Return type:

dict

Module contents

YAECS config module.