lenskit.metrics.ranking.Recall
==============================

.. py:class:: lenskit.metrics.ranking.Recall(n = None, *, k = None)
   :canonical: lenskit.metrics.ranking._pr.Recall

   Bases: :py:obj:`lenskit.metrics.ranking._base.ListMetric`, :py:obj:`lenskit.metrics.ranking._base.RankingMetricBase`


   Compute recommendation recall.  This is computed as:

   .. math::
       \frac{|L \cap I_u^{\mathrm{test}}|}{\operatorname{min}\{|I_u^{\mathrm{test}}|, k\}}


   .. py:property:: label

      The metric's default label in output.
      The base implementation returns the class name by default.


   .. py:method:: measure_list(recs, test)

      Compute measurements for a single list.

      :returns:

                - A float for simple metrics
                - Intermediate data for decomposed metrics
                - A dict mapping metric names to values for multi-metric classes