org.grouplens.lenskit.eval.algorithm

Class AlgorithmInstanceBuilder

java.lang.Object

org.grouplens.lenskit.eval.algorithm.AlgorithmInstanceBuilder

All Implemented Interfaces:

org.apache.commons.lang3.builder.Builder<AlgorithmInstance>

@ConfigDelegate(value=AlgorithmInstanceBuilderDelegate.class)
public class AlgorithmInstanceBuilder
extends Object
implements org.apache.commons.lang3.builder.Builder<AlgorithmInstance>

Command to get a algorithmInfo instances.

Constructor Summary

Constructors

Constructor and Description
AlgorithmInstanceBuilder()
AlgorithmInstanceBuilder(String name)

Method Summary

Modifier and Type	Method and Description
AlgorithmInstance	build()
AlgorithmInstanceBuilder	configureFromFile(Map<String,Object> attributes, File file) Configure the algorithmInfo instance builder from a file.
Map<String,Object>	getAttributes() Get the attributes of this algorithmInfo instance.
LenskitConfiguration	getConfig()
String	getName() Get the algorithmInfo name.
boolean	getPreload() Get whether this algorithmInfo will require ratings to be pre-loaded.
EvalProject	getProject() Get the project of this algorithmInfo
AlgorithmInstanceBuilder	setAttribute(String attr, Object value) Set an attribute for this algorithmInfo instance.
AlgorithmInstanceBuilder	setName(String n) Set the algorithmInfo name.
AlgorithmInstanceBuilder	setPreload(boolean pl) Deprecated. This method doesn't do anything anymore. Pack rating data if you want preloading.
AlgorithmInstanceBuilder	setProject(EvalProject prj) Set the project of Algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmInstanceBuilder

public AlgorithmInstanceBuilder()

AlgorithmInstanceBuilder

public AlgorithmInstanceBuilder(String name)

Method Detail

setName

public AlgorithmInstanceBuilder setName(String n)

Set the algorithmInfo name.

Parameters:

n - The name for this algorithmInfo instance.

Returns:

The command for chaining.

getName

public String getName()

Get the algorithmInfo name.

Returns:

The algortihm name.

getPreload

public boolean getPreload()

Get whether this algorithmInfo will require ratings to be pre-loaded.

Returns:

true if the algorithmInfo should have ratings pre-loaded into memory.

getProject

public EvalProject getProject()

Get the project of this algorithmInfo

Returns:

The project

setPreload

@Deprecated
public AlgorithmInstanceBuilder setPreload(boolean pl)

Deprecated. This method doesn't do anything anymore. Pack rating data if you want preloading.

Set whether the algorithmInfo wants ratings pre-loaded. Use this for algorithms that are too slow reading on a CSV file if you have enough memory to load them all.

Parameters:

pl - true to pre-load input data when running this algorithmInfo.

Returns:

The command for chaining.

setAttribute

public AlgorithmInstanceBuilder setAttribute(@Nonnull
                                             String attr,
                                             @Nonnull
                                             Object value)

Set an attribute for this algorithmInfo instance. Used for distinguishing similar instances in an algorithmInfo family.

Parameters:

attr - The attribute name.

value - The attribute value.

Returns:

The command for chaining.

setProject

public AlgorithmInstanceBuilder setProject(EvalProject prj)

Set the project of Algorithm.

Parameters:

prj - The project for this algorithmInfo.

Returns:

The command for chaining.

getAttributes

public Map<String,Object> getAttributes()

Get the attributes of this algorithmInfo instance.

Returns:

A map of user-defined attributes for this algorithmInfo instance.

getConfig

public LenskitConfiguration getConfig()

configureFromFile

public AlgorithmInstanceBuilder configureFromFile(Map<String,Object> attributes,
                                                  File file)
                                           throws RecommenderConfigurationException,
                                                  IOException

Configure the algorithmInfo instance builder from a file.

Parameters:

attributes - The attributes. Attributes 'name' and 'preload' are mapped to their corresponding real properties.

file - The file.

Returns:

The builder (for chaining).

Throws:

RecommenderConfigurationException - If there is an error running the script.

IOException - If there is an error loading the script.

build

public AlgorithmInstance build()

Specified by:

build in interface org.apache.commons.lang3.builder.Builder<AlgorithmInstance>