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

.. py:module:: lenskit.pipeline.config

.. autoapi-nested-parse::

   Pydantic models for pipeline configuration and serialization support.



Attributes
----------

.. autoapisummary::

   lenskit.pipeline.config.VALID_NAME


Classes
-------

.. toctree::
   :hidden:

   /api/lenskit/pipeline/config/PipelineHook
   /api/lenskit/pipeline/config/PipelineHooks
   /api/lenskit/pipeline/config/PipelineOptions
   /api/lenskit/pipeline/config/PipelineConfig
   /api/lenskit/pipeline/config/PipelineMeta
   /api/lenskit/pipeline/config/PipelineInput
   /api/lenskit/pipeline/config/PipelineComponent
   /api/lenskit/pipeline/config/PipelineLiteral

.. autoapisummary::

   lenskit.pipeline.config.PipelineHook
   lenskit.pipeline.config.PipelineHooks
   lenskit.pipeline.config.PipelineOptions
   lenskit.pipeline.config.PipelineConfig
   lenskit.pipeline.config.PipelineMeta
   lenskit.pipeline.config.PipelineInput
   lenskit.pipeline.config.PipelineComponent
   lenskit.pipeline.config.PipelineLiteral


Functions
---------

.. autoapisummary::

   lenskit.pipeline.config.check_name
   lenskit.pipeline.config.hash_config



Module Contents
---------------

.. py:data:: VALID_NAME

.. py:function:: check_name(name, *, what = 'node', allow_reserved = False)

   Check that a name is valid.

   :raises ValueError: If the specified name is not valid.


.. py:function:: hash_config(config)

   Compute the hash of a configuration model.

   :Stability: Internal



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

.. py:exception:: lenskit.pipeline.config.PipelineError

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

.. py:exception:: lenskit.pipeline.config.PipelineWarning

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

.. py:class:: lenskit.pipeline.config.HookEntry

    Re-exported alias for :py:class:`lenskit.pipeline._hooks.HookEntry`.

.. py:function:: lenskit.pipeline.config.is_union_type

    Re-exported alias for :py:func:`lenskit.pipeline._types.is_union_type`.

.. py:function:: lenskit.pipeline.config.make_importable_path

    Re-exported alias for :py:func:`lenskit.pipeline._types.make_importable_path`.

.. py:class:: lenskit.pipeline.config.Component

    Re-exported alias for :py:class:`lenskit.pipeline.components.Component`.

.. py:class:: lenskit.pipeline.config.ComponentConstructorNode

    Re-exported alias for :py:class:`lenskit.pipeline.nodes.ComponentConstructorNode`.

.. py:class:: lenskit.pipeline.config.ComponentInstanceNode

    Re-exported alias for :py:class:`lenskit.pipeline.nodes.ComponentInstanceNode`.

.. py:class:: lenskit.pipeline.config.ComponentNode

    Re-exported alias for :py:class:`lenskit.pipeline.nodes.ComponentNode`.

.. py:class:: lenskit.pipeline.config.InputNode

    Re-exported alias for :py:class:`lenskit.pipeline.nodes.InputNode`.