org.grouplens.lenskit.eval.data.traintest

Class GenericTTDataSet

java.lang.Object

org.grouplens.lenskit.eval.data.traintest.GenericTTDataSet

All Implemented Interfaces:

TTDataSet

public class GenericTTDataSet
extends Object
implements TTDataSet

A train-test data set backed by a pair of factories.

Since:

0.8

Constructor Summary

Constructors

Constructor and Description
GenericTTDataSet(String name, DataSource train, DataSource query, DataSource test, UUID grp, Map<String,Object> attrs)

Method Summary

Modifier and Type	Method and Description
void	configure(LenskitConfiguration config) Configure LensKit to have the training data from this data source.
GenericTTDataBuilder	copyBuilder() Create a new builder initialized with this data set's values.
static GenericTTDataBuilder	copyBuilder(TTDataSet data) Create a new builder initialized with this data set's values.
Map<String,Object>	getAttributes() Get the data set attributes (used for identification in output).
UUID	getIsolationGroup() Get the isolation group ID for this data set.
String	getName() Get the data set name.
EventDAO	getQueryDAO() Get the query data.
DataSource	getQueryData() Get the query data.
EventDAO	getTestDAO() Get the test data.
DataSource	getTestData() Get the training data.
EventDAO	getTrainingDAO() Get the training data.
DataSource	getTrainingData() Get the training data.
long	lastModified() Get the last modification time of this data set.
static GenericTTDataBuilder	newBuilder() Create a new generic train-test data set builder.
static GenericTTDataBuilder	newBuilder(String name) Create a new generic train-test data set builder.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericTTDataSet

public GenericTTDataSet(@Nonnull
                        String name,
                        @Nonnull
                        DataSource train,
                        @Nullable
                        DataSource query,
                        @Nonnull
                        DataSource test,
                        UUID grp,
                        Map<String,Object> attrs)

Method Detail

getName

@Nonnull
public String getName()

Description copied from interface: TTDataSet

Get the data set name.

Specified by:

getName in interface TTDataSet

Returns:

A name for the data set. Used in the output file.

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: TTDataSet

Get the data set attributes (used for identification in output).

Specified by:

getAttributes in interface TTDataSet

Returns:

A key → value map of the attributes used to identify this data set. For example, a crossfold data set may include the source name and fold number.

getIsolationGroup

public UUID getIsolationGroup()

Description copied from interface: TTDataSet

Get the isolation group ID for this data set. Data sets in the same group will be allowed to run in parallel. This is used to implement data set isolation.

Specified by:

getIsolationGroup in interface TTDataSet

Returns:

The group ID for this data set.

lastModified

public long lastModified()

Description copied from interface: TTDataSet

Get the last modification time of this data set.

Specified by:

lastModified in interface TTDataSet

Returns:

The last modification time, in milliseconds since the epoch.

getTrainingDAO

public EventDAO getTrainingDAO()

Description copied from interface: TTDataSet

Get the training data.

Specified by:

getTrainingDAO in interface TTDataSet

Returns:

An event DAO encompassing the training data.

getQueryDAO

public EventDAO getQueryDAO()

Description copied from interface: TTDataSet

Get the query data.

Specified by:

getQueryDAO in interface TTDataSet

Returns:

An event DAO encompassing the query data.

getTestDAO

public EventDAO getTestDAO()

Description copied from interface: TTDataSet

Get the test data.

Specified by:

getTestDAO in interface TTDataSet

Returns:

A DAO factory returning the test data.

getTestData

@Nonnull
public DataSource getTestData()

Description copied from interface: TTDataSet

Get the training data.

Specified by:

getTestData in interface TTDataSet

Returns:

A data source containing the test data.

getTrainingData

@Nonnull
public DataSource getTrainingData()

Description copied from interface: TTDataSet

Get the training data.

Specified by:

getTrainingData in interface TTDataSet

Returns:

A data source containing the training data.

getQueryData

public DataSource getQueryData()

Description copied from interface: TTDataSet

Get the query data.

Specified by:

getQueryData in interface TTDataSet

Returns:

A data source containing the query data.

configure

public void configure(LenskitConfiguration config)

Description copied from interface: TTDataSet

Configure LensKit to have the training data from this data source.

Specified by:

configure in interface TTDataSet

Parameters:

config - A configuration in which the training data for this data set should be configured.

toString

public String toString()

Overrides:

toString in class Object

newBuilder

public static GenericTTDataBuilder newBuilder()

Create a new generic train-test data set builder.

Returns:

The new builder.

newBuilder

public static GenericTTDataBuilder newBuilder(String name)

Create a new generic train-test data set builder.

Parameters:

name - The data set name.

Returns:

The new builder.

copyBuilder

public GenericTTDataBuilder copyBuilder()

Create a new builder initialized with this data set's values.

Returns:

A new builder initialized to make a copy of this data set definition.

copyBuilder

public static GenericTTDataBuilder copyBuilder(TTDataSet data)

Create a new builder initialized with this data set's values.

Returns:

A new builder initialized to make a copy of this data set definition.