org.grouplens.lenskit.eval.traintest

Class ExternalAlgorithmBuilder

java.lang.Object

org.grouplens.lenskit.eval.traintest.ExternalAlgorithmBuilder

All Implemented Interfaces:

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

public class ExternalAlgorithmBuilder
extends Object
implements org.apache.commons.lang3.builder.Builder<ExternalAlgorithm>

Command to get a algorithmInfo instances.

Constructor Summary

Constructors

Constructor and Description
ExternalAlgorithmBuilder()
ExternalAlgorithmBuilder(String name)

Method Summary

Modifier and Type	Method and Description
ExternalAlgorithm	build()
Map<String,Object>	getAttributes() Get the attributes of this algorithmInfo instance.
String	getName() Get the algorithmInfo name.
ExternalAlgorithmBuilder	setAttribute(String attr, Object value) Set an attribute for this algorithmInfo instance.
ExternalAlgorithmBuilder	setCommand(List<String> cmd) Set the command to run.
ExternalAlgorithmBuilder	setCommand(String... cmd)
ExternalAlgorithmBuilder	setName(String n) Set the algorithmInfo name.
ExternalAlgorithmBuilder	setOutputDelimiter(String delim) Set the delimiter of the recommender's output file.
ExternalAlgorithmBuilder	setWorkDir(File dir) Set the working directory for the external recommender.
ExternalAlgorithmBuilder	setWorkDir(String dir) Set the working directory for the external recommender.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalAlgorithmBuilder

public ExternalAlgorithmBuilder()

ExternalAlgorithmBuilder

public ExternalAlgorithmBuilder(String name)

Method Detail

setName

public ExternalAlgorithmBuilder 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 algorithmInfo's name.

setAttribute

public ExternalAlgorithmBuilder 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.

getAttributes

public Map<String,Object> getAttributes()

Get the attributes of this algorithmInfo instance.

Returns:

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

setCommand

public ExternalAlgorithmBuilder setCommand(List<String> cmd)

Set the command to run. In order to have access to the relevant files, the following strings will be substituted in command arguments:

• {OUTPUT} — the output file name (should be delimited text).
• {TRAIN_DATA} — the training CSV file name
• {TEST_DATA} — the test data CSV file name

Parameters:

cmd - The command to run (name and arguments).

Returns:

The command (for chaining)

setCommand

public ExternalAlgorithmBuilder setCommand(String... cmd)

setWorkDir

public ExternalAlgorithmBuilder setWorkDir(File dir)

Set the working directory for the external recommender.

Parameters:

dir - The working directory.

Returns:

The working directory.

setWorkDir

public ExternalAlgorithmBuilder setWorkDir(String dir)

Set the working directory for the external recommender.

Parameters:

dir - The working directory.

Returns:

The working directory.

setOutputDelimiter

public ExternalAlgorithmBuilder setOutputDelimiter(String delim)

Set the delimiter of the recommender's output file.

Parameters:

delim - The output delimiter. The default delimiter is ','.

Returns:

The input delimiter.

build

public ExternalAlgorithm build()

Specified by:

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