org.lenskit.eval.traintest

Class AlgorithmInstance

java.lang.Object

org.lenskit.eval.traintest.AlgorithmInstance

public class AlgorithmInstance
extends Object

An instance of a recommender algorithm to be trained and measured.

Constructor Summary

Constructors

Constructor and Description
AlgorithmInstance(String name, LenskitConfiguration config) Construct a new algorithm instance.
AlgorithmInstance(String name, List<LenskitConfiguration> configs, Map<String,Object> attrs) Construct a new algorithm instance.

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() Get the attributes of this algorithm.
List<LenskitConfiguration>	getConfigurations() Get the recommender configurations.
String	getName() Get the name of this algorithm.
static List<AlgorithmInstance>	load(Path file, String name, ClassLoader classLoader) Load an algorithm instance from a file.
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)

Construct a new algorithm instance.

Parameters:

name - The algorithm name.

config - The algorithm configuration.

AlgorithmInstance

public AlgorithmInstance(String name,
                         List<LenskitConfiguration> configs,
                         Map<String,Object> attrs)

Construct a new algorithm instance.

Parameters:

name - The algorithm name.

configs - The algorithm configurations.

attrs - The attributes for this algorithm instance.

Method Detail

getName

public String getName()

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

Returns:

The algorithm’s name

getAttributes

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

Get the attributes of this algorithm. These attributes are used to distinguish between similar algorithms, e.g. different configurations of the same basic algorithm.

Returns:

The algorithm attributes.

getConfigurations

@Nonnull
public List<LenskitConfiguration> getConfigurations()

Get the recommender configurations.

Returns:

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 configurations. These configurations come before the algorithm’s configuration, so they are overridden if appropriate. They are used for providing things such as DAOs.

Returns:

The recommender graph.

Throws:

RecommenderConfigurationException - if there is an error configuring the recommender.

load

public static List<AlgorithmInstance> load(Path file,
                                           String name,
                                           ClassLoader classLoader)

Load an algorithm instance from a file.

Parameters:

file - The file to load.

name - The algorithm name, or null to use the file’s basename.

classLoader - The class loader, or null to use a default.

Returns:

The list of loaded algorithm instances.

toString

public String toString()

Overrides:

toString in class Object