org.lenskit.eval.traintest.recommend

Class TopNLengthMetric

java.lang.Object

org.lenskit.eval.traintest.metrics.Metric<X>

org.lenskit.eval.traintest.recommend.TopNMetric<X>

org.lenskit.eval.traintest.recommend.ListOnlyTopNMetric<org.apache.commons.math3.stat.descriptive.moment.Mean>

org.lenskit.eval.traintest.recommend.TopNLengthMetric

public class TopNLengthMetric
extends ListOnlyTopNMetric<org.apache.commons.math3.stat.descriptive.moment.Mean>

Metric that measures how long a TopN list actually is.

This metric is registered with the type name length.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopNLengthMetric.LengthResult

Constructor Summary

Constructors

Constructor and Description
TopNLengthMetric() Construct a new length metric.

Method Summary

Modifier and Type	Method and Description
org.apache.commons.math3.stat.descriptive.moment.Mean	createContext(AlgorithmInstance algorithm, DataSet dataSet, RecommenderEngine engine) Create the context for an experimental condition (algorithm/data set pair).
MetricResult	getAggregateMeasurements(org.apache.commons.math3.stat.descriptive.moment.Mean context) Get the aggregate results from an accumulator.
MetricResult	measureUser(Recommender rec, TestUser user, int targetLength, LongList recommendations, org.apache.commons.math3.stat.descriptive.moment.Mean context) Measurement method that only uses the recommend list.

Methods inherited from class org.lenskit.eval.traintest.recommend.ListOnlyTopNMetric

measureUser

Methods inherited from class org.lenskit.eval.traintest.metrics.Metric

getAggregateColumnLabels, getColumnLabels, getRequiredRoots

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TopNLengthMetric

public TopNLengthMetric()

Construct a new length metric.

Method Detail

measureUser

@Nonnull
public MetricResult measureUser(Recommender rec,
                                         TestUser user,
                                         int targetLength,
                                         LongList recommendations,
                                         org.apache.commons.math3.stat.descriptive.moment.Mean context)

Description copied from class: ListOnlyTopNMetric

Measurement method that only uses the recommend list.

Thread Safety: This method may be called concurrently by multiple threads with the same recommender and context.

Specified by:

measureUser in class ListOnlyTopNMetric<org.apache.commons.math3.stat.descriptive.moment.Mean>

Parameters:

rec - The recommender used to recommend for this user.

user - The user.

targetLength - The target list length.

recommendations - The list of recommendations.

context - The context.

Returns:

The results of measuring this user.

createContext

@Nullable
public org.apache.commons.math3.stat.descriptive.moment.Mean createContext(AlgorithmInstance algorithm,
                                                                                     DataSet dataSet,
                                                                                     RecommenderEngine engine)

Description copied from class: Metric

Create the context for an experimental condition (algorithm/data set pair). The default implementation returns null.

Note: Contexts must be thread-safe, in that multiple concurrent calls to the appropriate user-measurement function with the same context must be safe. This can be handled either by the context itself, or by the user-measurement function.

Overrides:

createContext in class Metric<org.apache.commons.math3.stat.descriptive.moment.Mean>

Parameters:

algorithm - The algorithm.

dataSet - The data set.

engine - The LensKit recommender engine, if applicable. This can be null for an external algorithm that does not provide a LensKit recommender.

Returns:

The context. This will be passed to the individual measurement methods. If the metric does need to accumulate any results, this method can return null.

getAggregateMeasurements

@Nonnull
public MetricResult getAggregateMeasurements(org.apache.commons.math3.stat.descriptive.moment.Mean context)

Description copied from class: Metric

Get the aggregate results from an accumulator. The default implementation returns MetricResult.empty().

Overrides:

getAggregateMeasurements in class Metric<org.apache.commons.math3.stat.descriptive.moment.Mean>

Parameters:

context - The context for an experimental condition.

Returns:

The aggregate results from the accumulator.