Configuration API

KonfAI builds workflows from YAML by combining configuration decorators, constructor signatures, and recursive object instantiation.

class konfai.utils.config.Config(key)

Bases: object

Context manager for reading and updating a subtree of the active YAML config.

Parameters:

key (str) – Dot-separated path pointing to the configuration subtree to inspect or materialize.

konfai.utils.config.config(key=None)

Attach a KonfAI configuration key to a class or callable.

Parameters:

key (str | None) – Configuration branch handled by the decorated object.

Returns:

Decorator storing the key on the decorated object.

Return type:

Callable

konfai.utils.config.apply_config(konfai_args=None)

Recursively instantiate callables from the active KonfAI configuration.

Parameters:

konfai_args (str | None) – Root configuration path used to resolve nested constructor arguments.

Returns:

Decorator that injects configuration-backed arguments at call time.

Return type:

Callable

Related runtime helpers

These helpers expose the active workflow context after the CLI wrapper has set up the environment:

konfai.config_file()

Return the active configuration file used by the current workflow.

Return type:

Path

konfai.konfai_root()

Return the root configuration section name for the current workflow.

Return type:

str

konfai.konfai_state()

Return the current KonfAI workflow state stored in the environment.

Return type:

str

konfai.checkpoints_directory()

Return the configured checkpoint output directory.

Return type:

Path

konfai.predictions_directory()

Return the configured prediction output directory.

Return type:

Path

konfai.evaluations_directory()

Return the configured evaluation output directory.

Return type:

Path

konfai.statistics_directory()

Return the configured statistics output directory.

Return type:

Path

See also

• Configuration model

• Configuration reference