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

.. py:module:: lenskit.metrics

.. autoapi-nested-parse::

   Metrics for evaluating recommender outputs.



Submodules
----------

.. autoapisummary::

   lenskit.metrics.basic
   lenskit.metrics.bulk
   lenskit.metrics.predict
   lenskit.metrics.ranking
   lenskit.metrics.reranking

.. toctree::
    :hidden:
    :maxdepth: 1

    /api/lenskit/metrics/basic/index
    /api/lenskit/metrics/bulk/index
    /api/lenskit/metrics/predict/index
    /api/lenskit/metrics/ranking/index
    /api/lenskit/metrics/reranking/index

Attributes
----------

.. autoapisummary::

   lenskit.metrics.MetricResult
   lenskit.metrics.MetricVal


Classes
-------

.. toctree::
   :hidden:

   /api/lenskit/metrics/ListMetric
   /api/lenskit/metrics/Metric
   /api/lenskit/metrics/MetricFunction
   /api/lenskit/metrics/MeasurementCollector
   /api/lenskit/metrics/RunMetrics

.. autoapisummary::

   lenskit.metrics.ListMetric
   lenskit.metrics.Metric
   lenskit.metrics.MetricFunction
   lenskit.metrics.MeasurementCollector
   lenskit.metrics.RunMetrics


Functions
---------

.. autoapisummary::

   lenskit.metrics.quick_measure_model



Package Contents
----------------

.. py:type:: MetricResult
   :canonical: MetricVal | Mapping[str, MetricVal]


   Results of a metric, either a single value or a dictionary of values.

.. py:type:: MetricVal
   :canonical: float | int | object


   A single metric value.

.. py:function:: quick_measure_model(model, data, *, predicts_ratings = False, n_jobs = 1, rng = None)

   Do a quick-and-dirty model measurement with a default pipeline setup, split,
   and metrics. This is mostly to make tests easy to write, you usually don't
   want to use it for actual recommender evaluation.

   :Stability: Caller



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

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

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

.. py:class:: lenskit.metrics.ListLength

    Re-exported alias for :py:class:`lenskit.metrics.basic.ListLength`.

.. py:class:: lenskit.metrics.TestItemCount

    Re-exported alias for :py:class:`lenskit.metrics.basic.TestItemCount`.

.. py:class:: lenskit.metrics.RunAnalysis

    Re-exported alias for :py:class:`lenskit.metrics.bulk.RunAnalysis`.

.. py:class:: lenskit.metrics.RunAnalysisResult

    Re-exported alias for :py:class:`lenskit.metrics.bulk.RunAnalysisResult`.

.. py:class:: lenskit.metrics.MAE

    Re-exported alias for :py:class:`lenskit.metrics.predict.MAE`.

.. py:class:: lenskit.metrics.RMSE

    Re-exported alias for :py:class:`lenskit.metrics.predict.RMSE`.

.. py:class:: lenskit.metrics.DCG

    Re-exported alias for :py:class:`lenskit.metrics.ranking.DCG`.

.. py:class:: lenskit.metrics.ILS

    Re-exported alias for :py:class:`lenskit.metrics.ranking.ILS`.

.. py:class:: lenskit.metrics.NDCG

    Re-exported alias for :py:class:`lenskit.metrics.ranking.NDCG`.

.. py:class:: lenskit.metrics.RBP

    Re-exported alias for :py:class:`lenskit.metrics.ranking.RBP`.

.. py:class:: lenskit.metrics.Entropy

    Re-exported alias for :py:class:`lenskit.metrics.ranking.Entropy`.

.. py:class:: lenskit.metrics.ExposureGini

    Re-exported alias for :py:class:`lenskit.metrics.ranking.ExposureGini`.

.. py:class:: lenskit.metrics.GeometricRankWeight

    Re-exported alias for :py:class:`lenskit.metrics.ranking.GeometricRankWeight`.

.. py:class:: lenskit.metrics.Hit

    Re-exported alias for :py:class:`lenskit.metrics.ranking.Hit`.

.. py:class:: lenskit.metrics.ListGini

    Re-exported alias for :py:class:`lenskit.metrics.ranking.ListGini`.

.. py:class:: lenskit.metrics.LogRankWeight

    Re-exported alias for :py:class:`lenskit.metrics.ranking.LogRankWeight`.

.. py:class:: lenskit.metrics.MeanPopRank

    Re-exported alias for :py:class:`lenskit.metrics.ranking.MeanPopRank`.

.. py:class:: lenskit.metrics.Precision

    Re-exported alias for :py:class:`lenskit.metrics.ranking.Precision`.

.. py:class:: lenskit.metrics.RankBiasedEntropy

    Re-exported alias for :py:class:`lenskit.metrics.ranking.RankBiasedEntropy`.

.. py:class:: lenskit.metrics.RankingMetricBase

    Re-exported alias for :py:class:`lenskit.metrics.ranking.RankingMetricBase`.

.. py:class:: lenskit.metrics.RankWeight

    Re-exported alias for :py:class:`lenskit.metrics.ranking.RankWeight`.

.. py:class:: lenskit.metrics.Recall

    Re-exported alias for :py:class:`lenskit.metrics.ranking.Recall`.

.. py:class:: lenskit.metrics.RecipRank

    Re-exported alias for :py:class:`lenskit.metrics.ranking.RecipRank`.

.. py:function:: lenskit.metrics.least_item_promoted

    Re-exported alias for :py:func:`lenskit.metrics.reranking.least_item_promoted`.

.. py:function:: lenskit.metrics.rank_biased_overlap

    Re-exported alias for :py:func:`lenskit.metrics.reranking.rank_biased_overlap`.