org.grouplens.lenskit.eval.traintest

Class MetricFactory<T>

java.lang.Object

org.grouplens.lenskit.eval.traintest.MetricFactory<T>

Direct Known Subclasses:

FunctionMultiModelMetric.Factory, OutputPredictMetric.Factory, OutputTopNMetric.Factory

public abstract class MetricFactory<T>
extends Object

Create a metric for a train-test evaluation. This interface allows a metric to control its instantiation and lifecycle.

Since:

2.1

Constructor Summary

Constructors

Constructor and Description
MetricFactory()

Method Summary

Modifier and Type	Method and Description
abstract Metric<T>	createMetric(TrainTestEvalTask task)
static <T> MetricFactory<T>	forMetric(Metric<T> m) Create a metric factory that returns the provided pre-instantiated metric.
static <T> MetricFactory<T>	forMetricClass(Class<? extends Metric<T>> m) Create a metric factory that wraps a class.
abstract List<String>	getColumnLabels()
abstract List<String>	getUserColumnLabels()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricFactory

public MetricFactory()

Method Detail

createMetric

public abstract Metric<T> createMetric(TrainTestEvalTask task)
                                throws IOException

Throws:

IOException

getColumnLabels

public abstract List<String> getColumnLabels()

getUserColumnLabels

public abstract List<String> getUserColumnLabels()

forMetric

public static <T> MetricFactory<T> forMetric(Metric<T> m)

Create a metric factory that returns the provided pre-instantiated metric.

Parameters:

m - The metric.

Returns:

A metric factory that returns m.

forMetricClass

public static <T> MetricFactory<T> forMetricClass(Class<? extends Metric<T>> m)

Create a metric factory that wraps a class. The class is instantiated immediately.

Parameters:

m - The metric class.

Returns:

A metric factory that returns m.