TrainTest (lenskit-gradle 3.0-SNAPSHOT API)

org.lenskit.gradle.TrainTest

All Implemented Interfaces and Traits:

GradleUtils
```
class TrainTest
extends LenskitTask
```
Run a train-test evaluation.

Inherited fields
Fields inherited from class	Fields
`class JavaExec`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION`

Properties Summary

Properties
Type	Name and description
`Property<java.lang.Object>`	`cacheDirectory` The cache directory for the recommender.
`Property<java.lang.Boolean>`	`continueAfterError` Configure whether the evaluation will continue after errors.
`Property<java.lang.Object>`	`outputFile` The output file for recommendation output.
`Property<java.lang.Integer>`	`parallelTasks` Then number of parallel tasks to allow.
`Property<java.lang.Boolean>`	`shareModelComponents` Configure whether the evaluator should share model components between algorithms.
`Property<java.io.File>`	`specFile` The file name for writing out the experiment description.
`Property<java.lang.Integer>`	`threadCount` The thread count for the evaluator.
`Property<java.lang.Object>`	`userOutputFile` The user output file for recommendation output.

Constructor Summary

Constructors
Constructor and description
`TrainTest ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`algorithm(java.lang.String name, java.lang.Object file)` Load one or more algorithms from a file.
	`void`	`algorithm(java.lang.Object file)` Load one or more algorithms from a file.
	`void`	`cacheDirectory(java.lang.Object obj)`
	`void`	`continueAfterError(boolean v)`
	`void`	`dataSet(java.util.Map ds)` Add a data set.
	`void`	`dataSet(java.lang.Object ds)` Add a data set.
	`java.lang.Object`	`dataSet(org.lenskit.gradle.DataSetProvider cf)` Add a data sets produced by a crossfold task.
	`void`	`dataSet(groovy.lang.Closure block)` Configure a train-test data set.
	`java.lang.Object`	`dataSet(java.util.Map<java.lang.String, java.lang.Object> options, org.lenskit.gradle.DataSetProvider cf)` Add a data sets produced by a crossfold task or other data set provider.
	`void`	`doPrepare()`
	`java.lang.String`	`getCommand()`
	`java.util.List`	`getCommandArgs()`
	`java.lang.Object`	`getJson()`
	`java.util.Set<java.io.File>`	`getOutputFiles()`
	`void`	`outputFile(java.lang.Object obj)`
	`void`	`parallelTasks(int x)`
	`void`	`predict(groovy.lang.Closure block)` Configure a prediction task.
	`void`	`rank(groovy.lang.Closure block)` Configure a rank effectiveness task.
	`void`	`recommend(groovy.lang.Closure block)` Configure a top-N recommendation task.
	`void`	`shareModelComponents(boolean v)`
	`void`	`threadCount(int x)`
	`void`	`userOutputFile(java.lang.Object obj)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class LenskitTask`	`applyFinalSettings, doPrepare, exec, getArgs, getCommand, getCommandArgs, getInvoker, invoker, logFile, logFileLevel, logLevel, maxMemory`
`class JavaExec`	executable, executable, getDebug, setExecutable, setExecutable, exec, environment, environment, environment, environment, args, args, args, systemProperties, systemProperties, getSystemProperties, getClasspath, classpath, classpath, workingDir, workingDir, getEnvironment, setJvmArgs, setJvmArgs, setDebug, getExecutable, getArgs, getMain, setMain, setMain, setStandardOutput, setStandardOutput, setErrorOutput, setErrorOutput, setSystemProperties, setWorkingDir, setWorkingDir, setArgs, setArgs, setArgs, setArgs, setClasspath, setClasspath, systemProperty, systemProperty, isIgnoreExitValue, getStandardOutput, getCommandLine, getDefaultCharacterEncoding, setDefaultCharacterEncoding, getMinHeapSize, setMinHeapSize, getMaxHeapSize, setMaxHeapSize, getJvmArgs, jvmArgs, jvmArgs, jvmArgs, jvmArgs, getBootstrapClasspath, setBootstrapClasspath, bootstrapClasspath, bootstrapClasspath, getEnableAssertions, setEnableAssertions, getAllJvmArgs, setAllJvmArgs, setAllJvmArgs, copyTo, copyTo, copyTo, copyTo, setStandardInput, setStandardInput, getWorkingDir, setIgnoreExitValue, setIgnoreExitValue, getErrorOutput, setEnvironment, getStandardInput, conventionMapping, conventionMapping, getConventionMapping, getLogger, setProperty, toString, compareTo, compareTo, getName, execute, getActions, getState, getState, getPath, getExtensions, configure, configure, getDescription, leftShift, property, isEnabled, setEnabled, hasProperty, getGroup, getInputs, getInputs, setDescription, getProject, getAnt, getConvention, getLogging, getLogging, getStandardOutputCapture, getIdentityPath, setGroup, setDidWork, getDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, deleteAllActions, getEnabled, dependsOnTaskDidWork, getOutputs, getOutputs, getDestroyables, getLocalState, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getAsDynamicObject, isHasCustomActions, prependParallelSafeAction, injectIntoNewInstance, getTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, getExecuter, setExecuter, getTemporaryDirFactory, addValidator, getValidators, appendParallelSafeAction, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Property Detail
  - final Property<java.lang.Object> cacheDirectory
    
    The cache directory for the recommender.
  - final Property<java.lang.Boolean> continueAfterError
    
    Configure whether the evaluation will continue after errors.
  - final Property<java.lang.Object> outputFile
    
    The output file for recommendation output.
  - final Property<java.lang.Integer> parallelTasks
    
    Then number of parallel tasks to allow.
  - final Property<java.lang.Boolean> shareModelComponents
    
    Configure whether the evaluator should share model components between algorithms.
  - final Property<java.io.File> specFile
    
    The file name for writing out the experiment description. Do not change unless absolutely necessary.
  - final Property<java.lang.Integer> threadCount
    
    The thread count for the evaluator.
  - final Property<java.lang.Object> userOutputFile
    
    The user output file for recommendation output.
- Constructor Detail
  - TrainTest()
- Method Detail
  - void algorithm(java.lang.String name, java.lang.Object file)
    
    Load one or more algorithms from a file.
    Parameters:
    name - The algorithm name.
    file - The file.
  - void algorithm(java.lang.Object file)
    
    Load one or more algorithms from a file.
    Parameters:
    file - The algorithm file
  - @java.lang.Deprecated void cacheDirectory(java.lang.Object obj)
  - @java.lang.Deprecated void continueAfterError(boolean v)
  - void dataSet(java.util.Map ds)
    
    Add a data set.
    Parameters:
    ds - The data set configuration to add.
  - void dataSet(java.lang.Object ds)
    
    Add a data set.
    Parameters:
    ds - The file of the data set to add.
  - java.lang.Object dataSet(org.lenskit.gradle.DataSetProvider cf)
    
    Add a data sets produced by a crossfold task.
    Parameters:
    ds - The crossfold tasks to add.
  - void dataSet(@groovy.lang.DelegatesTo(DataSetConfig) groovy.lang.Closure block)
    
    Configure a train-test data set.
    Parameters:
    block - A block which will be used to configure a data set.
  - java.lang.Object dataSet(java.util.Map<java.lang.String, java.lang.Object> options, org.lenskit.gradle.DataSetProvider cf)
    
    Add a data sets produced by a crossfold task or other data set provider.
    This method supports options for adding the crossfolded data sets:
    
    isolate
    
    If true, isolates each of the data sets from each other and from other data sets by assigning each a random isolation group ID.
    
    Parameters:
    options - Options for adding the data sets.
    ds - The crossfold tasks to add.
  - @java.lang.Override void doPrepare()
  - @java.lang.Override java.lang.String getCommand()
  - @java.lang.Override java.util.List getCommandArgs()
  - @Input java.lang.Object getJson()
  - @OutputFiles java.util.Set<java.io.File> getOutputFiles()
  - @java.lang.Deprecated void outputFile(java.lang.Object obj)
  - @java.lang.Deprecated void parallelTasks(int x)
  - void predict(@groovy.lang.DelegatesTo(EvalTaskConfig) groovy.lang.Closure block)
    
    Configure a prediction task.
    Parameters:
    block - The block.
  - void rank(@groovy.lang.DelegatesTo(RecommendEvalTaskConfig) groovy.lang.Closure block)
    
    Configure a rank effectiveness task. This is built on recommend(Closure), but sets options to defaults that make the resulting task a rank effectiveness measure when used with suitable metrics such as NDCG.
    Parameters:
    block - The configuration block.
  - void recommend(@groovy.lang.DelegatesTo(RecommendEvalTaskConfig) groovy.lang.Closure block)
    
    Configure a top-N recommendation task.
    Parameters:
    block - The block.
  - @java.lang.Deprecated void shareModelComponents(boolean v)
  - @java.lang.Deprecated void threadCount(int x)
  - @java.lang.Deprecated void userOutputFile(java.lang.Object obj)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class TrainTest

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final Property<java.lang.Object> cacheDirectory

final Property<java.lang.Boolean> continueAfterError

final Property<java.lang.Object> outputFile

final Property<java.lang.Integer> parallelTasks

final Property<java.lang.Boolean> shareModelComponents

final Property<java.io.File> specFile

final Property<java.lang.Integer> threadCount

final Property<java.lang.Object> userOutputFile

Constructor Detail

TrainTest()

Method Detail

void algorithm(java.lang.String name, java.lang.Object file)

void algorithm(java.lang.Object file)

@java.lang.Deprecated void cacheDirectory(java.lang.Object obj)

@java.lang.Deprecated void continueAfterError(boolean v)

void dataSet(java.util.Map ds)

void dataSet(java.lang.Object ds)

java.lang.Object dataSet(org.lenskit.gradle.DataSetProvider cf)

void dataSet(@groovy.lang.DelegatesTo(DataSetConfig) groovy.lang.Closure block)

java.lang.Object dataSet(java.util.Map<java.lang.String, java.lang.Object> options, org.lenskit.gradle.DataSetProvider cf)

@java.lang.Override void doPrepare()

@java.lang.Override java.lang.String getCommand()

@java.lang.Override java.util.List getCommandArgs()

@Input java.lang.Object getJson()

@OutputFiles java.util.Set<java.io.File> getOutputFiles()

@java.lang.Deprecated void outputFile(java.lang.Object obj)

@java.lang.Deprecated void parallelTasks(int x)

void predict(@groovy.lang.DelegatesTo(EvalTaskConfig) groovy.lang.Closure block)

void rank(@groovy.lang.DelegatesTo(RecommendEvalTaskConfig) groovy.lang.Closure block)

void recommend(@groovy.lang.DelegatesTo(RecommendEvalTaskConfig) groovy.lang.Closure block)

@java.lang.Deprecated void shareModelComponents(boolean v)

@java.lang.Deprecated void threadCount(int x)

@java.lang.Deprecated void userOutputFile(java.lang.Object obj)