caikit.config
=============

.. py:module:: caikit.config

.. autoapi-nested-parse::

   Top-level configuration for the `caikit` library.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/caikit/config/config/index


Functions
---------

.. autoapisummary::

   caikit.config.configure
   caikit.config.get_config


Package Contents
----------------

.. py:function:: configure(config_yml_path: Optional[str] = None, config_dict: Optional[Dict[str, Any]] = None)

   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()`


.. py:function:: get_config() -> aconfig.Config

   Get the caikit configuration