org.grouplens.lenskit.eval

Class TrainModelTask<T>

java.lang.Object

com.google.common.util.concurrent.AbstractFuture<T>

org.grouplens.lenskit.eval.AbstractTask<T>

org.grouplens.lenskit.eval.TrainModelTask<T>

All Implemented Interfaces:

ListenableFuture<T>, Future<T>, EvalTask<T>

public class TrainModelTask<T>
extends AbstractTask<T>

Train a recommender algorithmInfo and process it with a function.

Constructor Summary

Constructors

Constructor and Description
TrainModelTask()
TrainModelTask(String name)

Method Summary

Modifier and Type	Method and Description
Function<LenskitRecommender,T>	getAction()
AlgorithmInstance	getAlgorithm()
DataSource	getInputData()
File	getWriteFile()
T	perform()
TrainModelTask<T>	setAction(Function<LenskitRecommender,T> act) Set the action to invoke.
TrainModelTask<T>	setAlgorithm(AlgorithmInstance algo) Configure the algorithmInfo.
TrainModelTask<T>	setInput(DataSource data) Specify the data source to train on.
TrainModelTask<T>	setWriteFile(File file) Specify a file to write.

Methods inherited from class org.grouplens.lenskit.eval.AbstractTask

execute, getName, getProject, setName, setProject

Methods inherited from class com.google.common.util.concurrent.AbstractFuture

addListener, cancel, get, get, interruptTask, isCancelled, isDone, set, setException, wasInterrupted

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.ListenableFuture

addListener

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Constructor Detail

TrainModelTask

public TrainModelTask()

TrainModelTask

public TrainModelTask(String name)

Method Detail

getAlgorithm

public AlgorithmInstance getAlgorithm()

getWriteFile

public File getWriteFile()

getInputData

public DataSource getInputData()

getAction

public Function<LenskitRecommender,T> getAction()

setAlgorithm

public TrainModelTask<T> setAlgorithm(AlgorithmInstance algo)

Configure the algorithmInfo.

Parameters:

algo - The algorithmInfo to configure.

Returns:

The command (for chaining).

setWriteFile

public TrainModelTask<T> setWriteFile(File file)

Specify a file to write. The trained recommender algorithmInfo will be written to this file.

Parameters:

file - The file name.

Returns:

The command (for chaining).

setInput

public TrainModelTask<T> setInput(DataSource data)

Specify the data source to train on.

Parameters:

data - The input data source.

Returns:

The builder (for chaining).

setAction

public TrainModelTask<T> setAction(Function<LenskitRecommender,T> act)

Set the action to invoke. The action's return value will be returned from perform().

Parameters:

act - The action to invoke.

Returns:

The command (for chaining).

perform

public T perform()
          throws TaskExecutionException

Specified by:

perform in class AbstractTask<T>

Throws:

TaskExecutionException