org.grouplens.lenskit.eval.algorithm

Class AlgorithmInstance

java.lang.Object

org.grouplens.lenskit.eval.algorithm.AlgorithmInstance

All Implemented Interfaces:

Attributed

@BuiltBy(value=AlgorithmInstanceBuilder.class)
public class AlgorithmInstance
extends Object
implements Attributed

An instance of a recommender algorithmInfo to be benchmarked.

Constructor Summary

Constructors

Constructor and Description
AlgorithmInstance(String name, LenskitConfiguration config)
AlgorithmInstance(String name, LenskitConfiguration cfg, Map<String,Object> attrs, boolean preload)

Method Summary

Modifier and Type	Method and Description
LenskitRecommender	buildRecommender(LenskitConfiguration defaults) Build a recommender.
DAGNode<Component,Dependency>	buildRecommenderGraph(LenskitConfiguration defaults) Build a recommender graph (but don't instantiate any objects).
Map<String,Object>	getAttributes()
LenskitConfiguration	getConfig()
String	getName() Get the name of this algorithmInfo.
boolean	getPreload() Query whether this algorithmInfo is to operate on in-memory data.
AlgorithmInstance	setRandom(Random rng) Let AlgorithmInstanceBuilder to pass random number generator to algorithmInfo instance
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmInstance

public AlgorithmInstance(String name,
                         LenskitConfiguration config)

AlgorithmInstance

public AlgorithmInstance(String name,
                         LenskitConfiguration cfg,
                         Map<String,Object> attrs,
                         boolean preload)

Method Detail

getName

public String getName()

Get the name of this algorithmInfo. This returns a short name which is used to identify the algorithmInfo or instance.

Specified by:

getName in interface Attributed

Returns:

The algorithmInfo's name

getPreload

public boolean getPreload()

Query whether this algorithmInfo is to operate on in-memory data.

Returns:

true if the ratings database should be loaded in-memory prior to running.

getAttributes

@Nonnull
public Map<String,Object> getAttributes()

Specified by:

getAttributes in interface Attributed

getConfig

@Nonnull
public LenskitConfiguration getConfig()

setRandom

public AlgorithmInstance setRandom(Random rng)

Let AlgorithmInstanceBuilder to pass random number generator to algorithmInfo instance

Parameters:

rng - The random number generator.

Returns:

The new algorithmInfo instance

buildRecommender

public LenskitRecommender buildRecommender(@Nullable
                                           LenskitConfiguration defaults)
                                    throws RecommenderBuildException

Build a recommender.

Parameters:

defaults - Additional configuration. This configuration comes before the algorithm's configuration, so it is overridden if appropriate. It is used for providing things such as DAOs.

Returns:

The instantiated recommender.

Throws:

RecommenderBuildException

buildRecommenderGraph

public DAGNode<Component,Dependency> buildRecommenderGraph(@Nullable
                                                           LenskitConfiguration defaults)
                                                    throws RecommenderConfigurationException

Build a recommender graph (but don't instantiate any objects).

Parameters:

defaults - Additional configuration. This configuration comes before the algorithm's configuration, so it is overridden if appropriate. It is used for providing things such as DAOs.

Returns:

The recommender graph.

Throws:

RecommenderConfigurationException - if there is an error configuring the recommender.

toString

public String toString()

Overrides:

toString in class Object