lenskit.schemas.pipeline
========================

.. py:module:: lenskit.schemas.pipeline

.. autoapi-nested-parse::

   Pydantic models for pipeline configuration and serialization support.



Attributes
----------

.. autoapisummary::

   lenskit.schemas.pipeline.UNSET_CODE


Classes
-------

.. toctree::
   :hidden:

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

.. autoapisummary::

   lenskit.schemas.pipeline.PipelineHook
   lenskit.schemas.pipeline.PipelineHooks
   lenskit.schemas.pipeline.PipelineOptions
   lenskit.schemas.pipeline.PipelineConfigFragment
   lenskit.schemas.pipeline.PipelineConfig
   lenskit.schemas.pipeline.PipelineMeta
   lenskit.schemas.pipeline.PipelineInput
   lenskit.schemas.pipeline.PipelineComponent
   lenskit.schemas.pipeline.PipelineLiteral


Functions
---------

.. autoapisummary::

   lenskit.schemas.pipeline.check_name
   lenskit.schemas.pipeline.hash_config
   lenskit.schemas.pipeline.merge_configs



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

.. py:data:: UNSET_CODE
   :value: '!UNSET'


.. 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


.. py:function:: merge_configs(base, update, *, path = (), _skip_comp = False)


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

.. py:exception:: lenskit.schemas.pipeline.PipelineError

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