Crossfold (lenskit-gradle 3.0-SNAPSHOT API)

org.lenskit.gradle.Crossfold

All Implemented Interfaces and Traits:

DataSources, org.lenskit.gradle.DataSetProvider
```
class Crossfold
extends LenskitTask
```
Crossfold a data set. This task can only crossfold a single data set; multiple tasks must be used to produce multiple cross-validation splits.
See Also:
DataSources
<http>

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.String>`	`dataSetName`
`boolean`	`includeTimestamps`
`java.lang.String`	`method`
`Property<java.lang.Object>`	`outputDir` The output directory for cross-validation.
`java.lang.String`	`outputFormat`
`java.lang.Integer`	`partitionCount`
`java.lang.Integer`	`sampleSize`

Constructor Summary

Constructors
Constructor and description
`Crossfold ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`dataSetName(java.lang.String name)`
	`void`	`doPrepare()`
	`java.lang.String`	`getCommand()`
	`java.util.List`	`getCommandArgs()`
	`java.io.File`	`getDataSetFile()`
	`java.util.Set<java.io.File>`	`getInputFiles()`
	`java.io.File`	`getOutputDirectory()`
	`java.lang.Object`	`holdout(int n, java.lang.String order = 'random')` Hold out a fixed number of ratings per user
	`java.lang.Object`	`holdoutFraction(double f, java.lang.String order = 'random')` Utility method to create a holdout-fraction user partition method.
	`void`	`input(java.lang.Object file)` Set the input source manifest.
	`void`	`input(java.util.Map spec)`
	`void`	`inputFile(java.lang.Object csv)` Configure an input CSV file of ratings.
	`void`	`method(java.lang.String m)` Set the method to use.
	`void`	`outputDir(java.lang.Object dir)`
	`void`	`outputFormat(java.lang.String fmt)` Specify an output format.
	`java.lang.Object`	`retain(int n, java.lang.String order = 'random')` Utility method to create a retain-N user partition method.
	`void`	`userPartitionMethod(java.lang.Object nop)` Deprecated method for user partitioning.

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.String> dataSetName
  - @java.lang.Deprecated boolean includeTimestamps
  - java.lang.String method
  - final Property<java.lang.Object> outputDir
    
    The output directory for cross-validation. Defaults to "build/$name.out", where $name is the name of the task.
  - java.lang.String outputFormat
  - java.lang.Integer partitionCount
  - java.lang.Integer sampleSize
- Constructor Detail
  - Crossfold()
- Method Detail
  - @java.lang.Deprecated void dataSetName(java.lang.String name)
  - @java.lang.Override void doPrepare()
  - @java.lang.Override java.lang.String getCommand()
  - @java.lang.Override @Input java.util.List getCommandArgs()
  - @java.lang.Override java.io.File getDataSetFile()
  - @InputFiles java.util.Set<java.io.File> getInputFiles()
  - @OutputDirectory java.io.File getOutputDirectory()
  - java.lang.Object holdout(int n, java.lang.String order = 'random')
    
    Hold out a fixed number of ratings per user
    Parameters:
    n - The number of ratings to hold out for each user.
    order - The sort order. Defaults to `random`.
  - java.lang.Object holdoutFraction(double f, java.lang.String order = 'random')
    
    Utility method to create a holdout-fraction user partition method.
    Parameters:
    f - The fraction of ratings to hold out per user.
    order - The sort order. Defaults to `random`.
  - void input(java.lang.Object file)
    
    Set the input source manifest.
    Parameters:
    file - The path to an input source manifest file (in YAML format).
  - void input(java.util.Map spec)
  - void inputFile(java.lang.Object csv)
    
    Configure an input CSV file of ratings. Convenience method; input(Object) is more general.
    Parameters:
    csv - A CSV file containing ratings.
  - void method(java.lang.String m)
    
    Set the method to use. Can be one of:
    - partition-users
    - sample-users
    - partition-items
    - sample-items
    - partition-entities
    - sample-entities
    Parameters:
    m - The method
  - @java.lang.Deprecated void outputDir(java.lang.Object dir)
  - void outputFormat(java.lang.String fmt)
    
    Specify an output format. Can be one of: - csv - gz
    Parameters:
    fmt
  - java.lang.Object retain(int n, java.lang.String order = 'random')
    
    Utility method to create a retain-N user partition method.
    Parameters:
    n - The number of ratings to hold out for each user.
    order - The sort order. Defaults to `random`.
  - @java.lang.Deprecated void userPartitionMethod(java.lang.Object nop)
    
    Deprecated method for user partitioning.
    deprecated:
    Use holdout and friends directly.
    
    Parameters:
    nop

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class Crossfold

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final Property<java.lang.String> dataSetName

@java.lang.Deprecated boolean includeTimestamps

java.lang.String method

final Property<java.lang.Object> outputDir

java.lang.String outputFormat

java.lang.Integer partitionCount

java.lang.Integer sampleSize

Constructor Detail

Crossfold()

Method Detail

@java.lang.Deprecated void dataSetName(java.lang.String name)

@java.lang.Override void doPrepare()

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

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

@java.lang.Override java.io.File getDataSetFile()

@InputFiles java.util.Set<java.io.File> getInputFiles()

@OutputDirectory java.io.File getOutputDirectory()

java.lang.Object holdout(int n, java.lang.String order = 'random')

java.lang.Object holdoutFraction(double f, java.lang.String order = 'random')

void input(java.lang.Object file)

void input(java.util.Map spec)

void inputFile(java.lang.Object csv)

void method(java.lang.String m)

@java.lang.Deprecated void outputDir(java.lang.Object dir)

void outputFormat(java.lang.String fmt)

java.lang.Object retain(int n, java.lang.String order = 'random')

@java.lang.Deprecated void userPartitionMethod(java.lang.Object nop)