habitat.config module

Modules

module default_structured_configs

Functions

def get_config(config_path: str, overrides: typing.Optional[typing.List[str]] = None, configs_dir: str = '/home/circleci/project/habitat-lab/habitat-lab/habitat/config') -> omegaconf.dictconfig.DictConfig
Returns habitat config object composed of configs from yaml file (config_path) and overrides.
def read_write(config: Container) -> typing.Generator[omegaconf.base.Node, None, None]
Temporarily authorizes the modification of a OmegaConf configuration within a context. Use the ‘with’ statement to enter the context.

Function documentation

def habitat.config.get_config(config_path: str, overrides: typing.Optional[typing.List[str]] = None, configs_dir: str = '/home/circleci/project/habitat-lab/habitat-lab/habitat/config') -> omegaconf.dictconfig.DictConfig

Returns habitat config object composed of configs from yaml file (config_path) and overrides.

Parameters
config_path path to the yaml config file.
overrides list of config overrides. For example, overrides=["habitat.seed=1"].
configs_dir path to the config files root directory (defaults to _HABITAT_CFG_DIR).
Returns composed config object.

def habitat.config.read_write(config: Container) -> typing.Generator[omegaconf.base.Node, None, None]

Temporarily authorizes the modification of a OmegaConf configuration within a context. Use the ‘with’ statement to enter the context.

Parameters
config The configuration object that should get writing access