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

.. py:module:: lenskit.config

.. autoapi-nested-parse::

   LensKit general configuration



Submodules
----------

.. autoapisummary::

   lenskit.config.common

.. toctree::
    :hidden:
    :maxdepth: 1

    /api/lenskit/config/common/index

Functions
---------

.. autoapisummary::

   lenskit.config.lenskit_config
   lenskit.config.configure
   lenskit.config.locate_configuration_root



Package Contents
----------------

.. py:function:: lenskit_config()

   Get the LensKit configuration.

   If no configuration has been specified, returns a default settings object.


.. py:function:: configure(cfg_dir: pathlib.Path | None = None) -> lenskit.schemas.settings.LenskitSettings
                 configure(cfg_dir: pathlib.Path | None = None, *, settings_cls: type[SettingsClass]) -> SettingsClass
                 configure(settings: lenskit.schemas.settings.LenskitSettings, /) -> lenskit.schemas.settings.LenskitSettings

   Initialize LensKit configuration.

   LensKit does **not** automatically read configuration files — if this
   function is never called, then configuration will entirely be done through
   defaults and environment variables.

   This function will automatically configure the global RNG, if a seed is
   specified.  It does **not** configure logging.

   :param cfg_dir: The directory in which to look for configuration files..  If not
                   provided, uses the current directory.
   :param settings_cls: The base LensKit settings class.  Rarely used, only needed if a
                        project wants to to extend LensKit settings with their own settings.

   :returns: The configured LensKit settings.


.. py:function:: locate_configuration_root(*, cwd = None, abort_at_pyproject = True, abort_at_gitroot = True)

   Search for a configuration root containing a ``lenskit.toml`` file.

   This searches for a ``lenskit.toml`` file, beginning in the current working
   directory (or the alternate ``cwd`` if provided), and searching upward until
   one is found.  Search stops if a ``pyproject.toml`` file or ``.git``
   directory is found without encountering ``lenskit.toml``.



Exported Aliases
----------------

.. py:exception:: lenskit.config.ConfigWarning

    Re-exported alias for :py:exc:`lenskit.diagnostics.ConfigWarning`.

.. py:function:: lenskit.config.get_logger

    Re-exported alias for :py:func:`lenskit.logging.get_logger`.

.. py:function:: lenskit.config.init_global_rng

    Re-exported alias for :py:func:`lenskit.random.init_global_rng`.

.. py:class:: lenskit.config.LenskitSettings

    Re-exported alias for :py:class:`lenskit.schemas.settings.LenskitSettings`.

.. py:class:: lenskit.config.MachineSettings

    Re-exported alias for :py:class:`lenskit.schemas.settings.MachineSettings`.

.. py:class:: lenskit.config.ParallelSettings

    Re-exported alias for :py:class:`lenskit.schemas.settings.ParallelSettings`.

.. py:class:: lenskit.config.PowerQueries

    Re-exported alias for :py:class:`lenskit.schemas.settings.PowerQueries`.

.. py:class:: lenskit.config.PrometheusSettings

    Re-exported alias for :py:class:`lenskit.schemas.settings.PrometheusSettings`.

.. py:class:: lenskit.config.RandomSettings

    Re-exported alias for :py:class:`lenskit.schemas.settings.RandomSettings`.

.. py:class:: lenskit.config.TuneSettings

    Re-exported alias for :py:class:`lenskit.schemas.settings.TuneSettings`.