lenskit.pipeline.components
===========================

.. py:module:: lenskit.pipeline.components

.. autoapi-nested-parse::

   Definition of the component interfaces.



Attributes
----------

.. autoapisummary::

   lenskit.pipeline.components.PipelineFunction


Classes
-------

.. toctree::
   :hidden:

   /api/lenskit/pipeline/components/ComponentInput
   /api/lenskit/pipeline/components/ComponentConstructor
   /api/lenskit/pipeline/components/Component
   /api/lenskit/pipeline/components/PlaceholderConfig
   /api/lenskit/pipeline/components/Placeholder

.. autoapisummary::

   lenskit.pipeline.components.ComponentInput
   lenskit.pipeline.components.ComponentConstructor
   lenskit.pipeline.components.Component
   lenskit.pipeline.components.PlaceholderConfig
   lenskit.pipeline.components.Placeholder


Functions
---------

.. autoapisummary::

   lenskit.pipeline.components.component_inputs
   lenskit.pipeline.components.component_return_type
   lenskit.pipeline.components.fallback_on_none
   lenskit.pipeline.components.is_component_class



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

.. py:type:: PipelineFunction
   :canonical: Callable[..., COut]


   Pure-function interface for pipeline functions.

.. py:function:: component_inputs[COut](component, *, warn_on_missing = True, _warn_level = 1)

.. py:function:: component_return_type[COut](component)

.. py:function:: fallback_on_none[T](primary, fallback)

   Fallback to a second component if the primary input is `None`.

   :Stability: Caller


.. py:function:: is_component_class(obj)

   Check if the provided object is a component class.



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

.. py:exception:: lenskit.pipeline.components.PipelineWarning

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

.. py:class:: lenskit.pipeline.components.Lazy

    Re-exported alias for :py:class:`lenskit.lazy.Lazy`.

.. py:exception:: lenskit.pipeline.components.TypecheckWarning

    Re-exported alias for :py:exc:`lenskit.pipeline._types.TypecheckWarning`.

.. py:function:: lenskit.pipeline.components.is_compatible_data

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