lenskit.metrics.predict
=======================

.. py:module:: lenskit.metrics.predict

.. autoapi-nested-parse::

   Prediction accuracy metrics.  See :ref:`eval-predict-accuracy` for an overview
   and instructions on using these metrics.



Attributes
----------

.. autoapisummary::

   lenskit.metrics.predict.MissingDisposition
   lenskit.metrics.predict.ScoreArray
   lenskit.metrics.predict.PredMetric


Classes
-------

.. toctree::
   :hidden:

   /api/lenskit/metrics/predict/PredictMetric
   /api/lenskit/metrics/predict/RMSE
   /api/lenskit/metrics/predict/MAE
   /api/lenskit/metrics/predict/AvgErrorAccumulator

.. autoapisummary::

   lenskit.metrics.predict.PredictMetric
   lenskit.metrics.predict.RMSE
   lenskit.metrics.predict.MAE
   lenskit.metrics.predict.AvgErrorAccumulator



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

.. py:type:: MissingDisposition
   :canonical: Literal['error', 'ignore']


.. py:type:: ScoreArray
   :canonical: NDArray[np.floating] | pd.Series


.. py:type:: PredMetric
   :canonical: Callable[[ScoreArray, ScoreArray], float]



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

.. py:class:: lenskit.metrics.predict.ItemList

    Re-exported alias for :py:class:`lenskit.data.ItemList`.

.. py:data:: lenskit.metrics.predict.ITEM_COMPAT_COLUMN

    Re-exported alias for :py:data:`lenskit.data._adapt.ITEM_COMPAT_COLUMN`.

.. py:function:: lenskit.metrics.predict.normalize_columns

    Re-exported alias for :py:func:`lenskit.data._adapt.normalize_columns`.

.. py:class:: lenskit.metrics.predict.ValueStatAccumulator

    Re-exported alias for :py:class:`lenskit.data.accum.ValueStatAccumulator`.

.. py:class:: lenskit.metrics.predict.AliasedColumn

    Re-exported alias for :py:class:`lenskit.data.types.AliasedColumn`.

.. py:class:: lenskit.metrics.predict.Metric

    Re-exported alias for :py:class:`lenskit.metrics._base.Metric`.