lenskit-eval:run-eval

Full name:

org.grouplens.lenskit:lenskit-eval-maven-plugin:1.3:run-eval

Description:

Run a LensKit evaluation script.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Invokes the execution of the lifecycle phase package prior to executing itself.

Optional Parameters

Name Type Since Description
analysisDir String - Location of output data from the eval script.
Default value is: ..
User property is: lenskit.eval.analysisDir.
dataDir String - Location of input data; any train-test sets will be placed here, too.
Default value is: ..
User property is: lenskit.eval.dataDir.
force boolean - Turn on to force eval steps to run.
User property is: lenskit.eval.force.
script String - Name of recommender script. If none is given and scriptFiles is not configured, default to use "eval.groovy"
Default value is: eval.groovy.
User property is: lenskit.eval.script.
scriptFiles FileSet - Pattern of the set of evaluation files. If this is configured, scriptFiles takes precedence over script.
User property is: lenskit.eval.scripts.
skip boolean - Skip running the evaluator. This parameter allows the evaluator to be skipped, useful if you just want to re-run later phases (e.g. the analysis) without re-running the entire evaluation. To do that, run with mvn -Dlenskit.eval.skip=true.
User property is: lenskit.eval.skip.
targets List - Targets to run in the eval script.
User property is: lenskit.eval.targets.
threadCount int - The number of evaluation threads to run. A thread count of 0 uses as many threads as there are available processors.
User property is: lenskit.eval.threadCount.

Parameter Details

analysisDir:

Location of output data from the eval script.
  • Type: java.lang.String
  • Required: No
  • User Property: lenskit.eval.analysisDir
  • Default: .

dataDir:

Location of input data; any train-test sets will be placed here, too.
  • Type: java.lang.String
  • Required: No
  • User Property: lenskit.eval.dataDir
  • Default: .

force:

Turn on to force eval steps to run.
  • Type: boolean
  • Required: No
  • User Property: lenskit.eval.force

script:

Name of recommender script. If none is given and scriptFiles is not configured, default to use "eval.groovy"
  • Type: java.lang.String
  • Required: No
  • User Property: lenskit.eval.script
  • Default: eval.groovy

scriptFiles:

Pattern of the set of evaluation files. If this is configured, scriptFiles takes precedence over script.
  • Type: org.apache.maven.model.FileSet
  • Required: No
  • User Property: lenskit.eval.scripts

skip:

Skip running the evaluator. This parameter allows the evaluator to be skipped, useful if you just want to re-run later phases (e.g. the analysis) without re-running the entire evaluation. To do that, run with mvn -Dlenskit.eval.skip=true.
  • Type: boolean
  • Required: No
  • User Property: lenskit.eval.skip

targets:

Targets to run in the eval script.
  • Type: java.util.List
  • Required: No
  • User Property: lenskit.eval.targets

threadCount:

The number of evaluation threads to run. A thread count of 0 uses as many threads as there are available processors.
  • Type: int
  • Required: No
  • User Property: lenskit.eval.threadCount