lenskit.config.LenskitSettings#

class lenskit.config.LenskitSettings#

Bases: pydantic_settings.BaseSettings

Definition of LensKit settings.

LensKit supports loading various settings from configuration files and the environment as a consistent way to control LensKit’s various control surfaces.

Stability:

Experimental

model_config#
random: RandomSettings#

Random number generator configuration.

parallel: ParallelSettings#
machine: str | None = None#

The name of the machine running experiments.

This is usually set in lenskit.local.toml or the LK_MACHINE environment variable.

prometheus: PrometheusSettings#

Prometheus settings for task metric collection.

machines: dict[str, MachineSettings]#

Description of different machines used in the experiment(s), to support things like collecting power metrics.

tuning: TuneSettings#

LensKit tuning settings.

property current_machine: MachineSettings | None#
Return type:

MachineSettings | None

classmethod settings_customise_sources(settings_cls, init_settings, env_settings, dotenv_settings, file_secret_settings)#
finish_setup()#

Finalize settings, resolving default values etc. as needed.