caikit.config

Top-level configuration for the caikit library.

Submodules

Functions

configure([config_yml_path, config_dict])

Configure caikit for your usage!

get_config(→ aconfig.Config)

Get the caikit configuration

Package Contents

caikit.config.configure(config_yml_path: str | None = None, config_dict: Dict[str, Any] | None = None)[source]

Configure caikit for your usage! Merges into the internal aconfig.Config object with overrides from multiple sources.

Sources, last takes precedence:

  1. The existing configuration from calls to caikit.configure()

  2. The config from config_yml_path

  3. The config from config_dict

  4. The config files specified in the config_files configuration

    (NB: This may be set by the CONFIG_FILES environment variable)

  5. Environment variables, in ALL_CAPS_SNAKE_FORMAT

Args:
config_yml_path (Optional[str]): The path to the base configuration yaml

with overrides for your usage.

config_dict (Optional[Dict]): Config overrides in dictionary form

Returns: None: This only sets the config object that is returned by

caikit.get_config()

caikit.config.get_config() → aconfig.Config[source]

Get the caikit configuration