lenskit.pipeline.PipelineState
==============================

.. py:class:: lenskit.pipeline.PipelineState(state = None, aliases = None, default = None, meta = None)
   :canonical: lenskit.pipeline._state.PipelineState

   Bases: :py:obj:`collections.abc.Mapping`\ [\ :py:obj:`str`\ , :py:obj:`Any`\ ]


   Full results of running a pipeline.  A pipeline state is a dictionary
   mapping node names to their results; it is implemented as a separate class
   instead of directly using a dictionary to allow data to be looked up by node
   aliases in addition to original node names (and to be read-only).

   Client code will generally not construct this class directly.

   :Stability: Calller

   :param state: The pipeline state to wrap.  The state object stores a reference to
                 this dictionary.
   :param aliases: Dictionary of node aliases.
   :param default: The name of the default node (whose data should be returned by
                   :attr:`default` ).
   :param meta: The metadata for the pipeline generating this state.


   .. py:attribute:: meta
      :type:  lenskit.pipeline.config.PipelineMeta | None

      Pipeline metadata.


   .. py:property:: default
      :type: Any


      Return the data from of the default node (typically the last node run).

      :returns: The data associated with the default node.

      :raises ValueError: if there is no specified default node.


   .. py:property:: default_node
      :type: str | None


      Return the name of the default node (typically the last node run).


   .. py:method:: __len__()


   .. py:method:: __contains__(key)


   .. py:method:: __getitem__(key)


   .. py:method:: __iter__()


   .. py:method:: __str__()


   .. py:method:: __repr__()