Skip to content

README

liblaf.cherries.config

Classes:

  • BaseConfig

    Base class for experiment configuration models.

BaseConfig

Bases: BaseSettings


              flowchart TD
              liblaf.cherries.config.BaseConfig[BaseConfig]

              

              click liblaf.cherries.config.BaseConfig href "" "liblaf.cherries.config.BaseConfig"
            

Base class for experiment configuration models.

Subclass BaseConfig when an experiment callable should receive structured settings. main instantiates missing annotated arguments, logs Pydantic models as parameters, and then calls the experiment. The default settings config enables CLI parsing and converts field names to kebab-case flags.

Examples:

>>> class Config(BaseConfig):
...     name: str = "world"
...     epochs: int = 3
>>> Config.model_fields["name"].default
'world'

Attributes:

model_config class-attribute

model_config: SettingsConfigDict = SettingsConfigDict(
    cli_parse_args=True, cli_kebab_case=True
)