org.lenskit.eval.temporal

Class TemporalEvaluator

java.lang.Object

org.lenskit.eval.temporal.TemporalEvaluator

public class TemporalEvaluator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TemporalEvaluator()

Method Summary

Modifier and Type	Method and Description
void	execute() During the evaluation, it will replay the ratings, try to predict each one, and write the prediction, TARMSE and the rating to the output file
java.nio.file.Path	getExtendedOutputFile() Get the output file for extended output (lines of JSON).
int	getListSize()
java.nio.file.Path	getOutputFile()
long	getRebuildPeriod()
TemporalEvaluator	setAlgorithm(AlgorithmInstance algo) Adds an algorithmInfo
TemporalEvaluator	setAlgorithm(java.lang.String name, LenskitConfiguration config) An algorithm instance constructed with a name and Lenskit configuration
TemporalEvaluator	setDataSource(DataAccessObject dao)
TemporalEvaluator	setDataSource(java.io.File file)
TemporalEvaluator	setExtendedOutputFile(java.io.File file) Set the output file for extended output (lines of JSON).
TemporalEvaluator	setExtendedOutputFile(java.nio.file.Path file) Set the output file for extended output (lines of JSON).
TemporalEvaluator	setListSize(int lSize) sets the size of recommendationss list size
TemporalEvaluator	setOutputFile(java.io.File file)
TemporalEvaluator	setRebuildPeriod(long seconds)
TemporalEvaluator	setRebuildPeriod(long time, java.util.concurrent.TimeUnit unit)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporalEvaluator

public TemporalEvaluator()

Method Detail

setAlgorithm

public TemporalEvaluator setAlgorithm(AlgorithmInstance algo)

Adds an algorithmInfo

Parameters:

algo - The algorithmInfo added

Returns:

Itself to allow chaining

setAlgorithm

public TemporalEvaluator setAlgorithm(java.lang.String name,
                                      LenskitConfiguration config)

An algorithm instance constructed with a name and Lenskit configuration

Parameters:

name - Name of algorithm instance

config - Lenskit configuration

setDataSource

public TemporalEvaluator setDataSource(DataAccessObject dao)

Parameters:

dao - The datasource to be added to the command.

Returns:

Itself to allow for method chaining.

setDataSource

public TemporalEvaluator setDataSource(java.io.File file)
                                throws java.io.IOException

Parameters:

file - The file contains the ratings input data

Returns:

itself

Throws:

java.io.IOException

setOutputFile

public TemporalEvaluator setOutputFile(java.io.File file)

Parameters:

file - The file set as the output of the command

Returns:

Itself for method chaining

getExtendedOutputFile

@Nullable
public java.nio.file.Path getExtendedOutputFile()

Get the output file for extended output (lines of JSON).

Returns:

the output file.

setExtendedOutputFile

public TemporalEvaluator setExtendedOutputFile(@Nullable
                                               java.io.File file)

Set the output file for extended output (lines of JSON).

Parameters:

file - The output file name.

Returns:

The evaluator (for chaining).

setExtendedOutputFile

public TemporalEvaluator setExtendedOutputFile(@Nullable
                                               java.nio.file.Path file)

Set the output file for extended output (lines of JSON).

Parameters:

file - The output file name.

Returns:

The evaluator (for chaining).

setRebuildPeriod

public TemporalEvaluator setRebuildPeriod(long time,
                                          java.util.concurrent.TimeUnit unit)

Parameters:

time - The time to rebuild

unit - Unit of time set

Returns:

Itself for method chaining

setRebuildPeriod

public TemporalEvaluator setRebuildPeriod(long seconds)

Parameters:

seconds - default rebuild period in seconds

Returns:

Itself for method chaining

setListSize

public TemporalEvaluator setListSize(int lSize)

sets the size of recommendationss list size

Parameters:

lSize - size of list to be set

Returns:

returns itself

getOutputFile

public java.nio.file.Path getOutputFile()

Returns:

Returns prediction output file

getRebuildPeriod

public long getRebuildPeriod()

Returns:

Returns rebuild period

getListSize

public int getListSize()

Returns:

size of recommendation list

execute

public void execute()
             throws java.io.IOException,
                    RecommenderBuildException

During the evaluation, it will replay the ratings, try to predict each one, and write the prediction, TARMSE and the rating to the output file

Throws:

java.io.IOException

RecommenderBuildException