lenskit.metrics.basic#

Basic set statistics.

Classes#

ListLength

Report the length of the output (recommendation list or predictions).

TestItemCount

Report the number of test items.

Module Contents#

class lenskit.metrics.basic.ListLength#

Bases: lenskit.metrics._base.ListMetric

Report the length of the output (recommendation list or predictions).

Stability:
Caller (see Stability Levels).
label = 'N'#

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

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

Parameters:
Return type:

float

class lenskit.metrics.basic.TestItemCount#

Bases: lenskit.metrics._base.Metric

Report the number of test items.

Stability:
Caller (see Stability Levels).
label = 'TestItemCount'#

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

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

Parameters:
Return type:

float

Exported Aliases#

class lenskit.metrics.basic.ItemList#

Re-exported alias for lenskit.data.ItemList.

class lenskit.metrics.basic.ListMetric#

Re-exported alias for lenskit.metrics._base.ListMetric.

class lenskit.metrics.basic.Metric#

Re-exported alias for lenskit.metrics._base.Metric.