kd.konfig.register_default_values

kd.konfig.register_default_values#

kauldron.konfig.register_default_values(
default_values: Annotated[Any, None],
) → None[source]

Register default values when creating the ConfigDict.

Some class want to inject default values when being created as ConfigDict, like:

  • cfg = kd.train.Trainer() create cfg.workdir = placeholder(), so the user don’t need to specify it in it’s config

  • cfg = kxm.Job() create cfg.executor = Borg(), to allow the CLI to access nested fields (e.g. job.executor.scheduling.max_task_failures = 0) without having to define them in the get_config().

Usage:

with konfig.imports():
  from kauldron import kd

konfig.register_default_values(
    kd.train.Trainer(
        workdir=konfig.placeholder(str),
    )
)
Parameters:

default_values – The default ConfigDict to create.