lenskit.config.LenskitSettings
==============================

.. py:class:: lenskit.config.LenskitSettings
   :canonical: lenskit.config._schema.LenskitSettings

   Bases: :py:obj:`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


   .. py:attribute:: model_config


   .. py:attribute:: random
      :type:  RandomSettings

      Random number generator configuration.


   .. py:attribute:: parallel
      :type:  ParallelSettings


   .. py:attribute:: machine
      :type:  str | None
      :value: None


      The name of the machine running experiments.

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


   .. py:attribute:: prometheus
      :type:  PrometheusSettings

      Prometheus settings for task metric collection.


   .. py:attribute:: machines
      :type:  dict[str, MachineSettings]

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


   .. py:attribute:: tuning
      :type:  TuneSettings

      LensKit tuning settings.


   .. py:property:: current_machine
      :type: MachineSettings | None



   .. py:method:: settings_customise_sources(settings_cls, init_settings, env_settings, dotenv_settings, file_secret_settings)
      :classmethod:



   .. py:method:: finish_setup()

      Finalize settings, resolving default values etc. as needed.