R/irace-options.R

In irace: Iterated Racing for Automatic Algorithm Configuration

## This file was generated by scripts/generate-options.R
# Non-variable options (such as --help and --version) have names starting with "."
# Variables that do not have a command-line option have description == ""
# Types are b(oolean), i(nteger), s(tring), r(eal), p(ath), x (R object or no value)
# FIXME: Add special type for R functions.
# FIXME: For i and r add their domain.
.irace.params.def <- structure(list(name = c(".help", ".version", ".check", ".init", 
".onlytest", "scenarioFile", "execDir", "parameterFile", "forbiddenExps", 
"forbiddenFile", "initConfigurations", "configurationsFile", 
"logFile", "recoveryFile", "instances", "trainInstancesDir", 
"trainInstancesFile", "sampleInstances", "testInstancesDir", 
"testInstancesFile", "testInstances", "testNbElites", "testIterationElites", 
"testType", "firstTest", "eachTest", "targetRunner", "targetRunnerLauncher", 
"targetRunnerLauncherArgs", "targetRunnerRetries", "targetRunnerData", 
"targetRunnerParallel", "targetEvaluator", "deterministic", "maxExperiments", 
"maxTime", "budgetEstimation", "minMeasurableTime", "parallel", 
"loadBalancing", "mpi", "batchmode", "digits", "quiet", "debugLevel", 
"seed", "softRestart", "softRestartThreshold", "elitist", "elitistNewInstances", 
"elitistLimit", "repairConfiguration", "capping", "cappingType", 
"boundType", "boundMax", "boundDigits", "boundPar", "boundAsTimeout", 
"postselection", "aclib", "nbIterations", "nbExperimentsPerIteration", 
"minNbSurvival", "nbConfigurations", "mu", "confidence"), type = c("x", 
"x", "x", "x", "p", "p", "p", "p", "x", "p", "x", "p", "p", "p", 
"s", "p", "p", "b", "p", "p", "x", "i", "b", "s", "i", "i", "p", 
"p", "s", "i", "x", "x", "p", "b", "i", "i", "r", "r", "i", "b", 
"b", "s", "i", "b", "i", "i", "b", "r", "b", "i", "i", "x", "b", 
"s", "s", "i", "i", "i", "b", "r", "b", "i", "i", "i", "i", "i", 
"r"), short = c("-h", "-v", "-c", "-i", "", "-s", "", "-p", "", 
"", "", "", "-l", "", "", "", "", "", "", "", "", "", "", "", 
"", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", 
"", "", "", "-q", "", "", "", "", "-e", "", "", "", "", "", "", 
"", "", "", "", "", "", "", "", "", "", "", ""), long = c("--help", 
"--version", "--check", "--init", "--only-test", "--scenario", 
"--exec-dir", "--parameter-file", "", "--forbidden-file", "", 
"--configurations-file", "--log-file", "--recovery-file", "", 
"--train-instances-dir", "--train-instances-file", "--sample-instances", 
"--test-instances-dir", "--test-instances-file", "", "--test-num-elites", 
"--test-iteration-elites", "--test-type", "--first-test", "--each-test", 
"--target-runner", "--target-runner-launcher", "--target-runner-args", 
"--target-runner-retries", "", "", "--target-evaluator", "--deterministic", 
"--max-experiments", "--max-time", "--budget-estimation", "--min-measurable-time", 
"--parallel", "--load-balancing", "--mpi", "--batchmode", "--digits", 
"--quiet", "--debug-level", "--seed", "--soft-restart", "--soft-restart-threshold", 
"--elitist", "--elitist-new-instances", "--elitist-limit", "", 
"--capping", "--capping-type", "--bound-type", "--bound-max", 
"--bound-digits", "--bound-par", "--bound-as-timeout", "--postselection", 
"--aclib", "--iterations", "--experiments-per-iteration", "--min-survival", 
"--num-configurations", "--mu", "--confidence"), default = c(NA, 
NA, NA, "", "", "./scenario.txt", "./", "./parameters.txt", "", 
"", "", "", "./irace.Rdata", "", "", "./Instances", "", "1", 
"", "", "", "1", "0", "", "5", "1", "./target-runner", "", "{targetRunner} {targetRunnerArgs}", 
"0", "", "", "", "0", "0", "0", "0.02", "0.01", "0", "1", "0", 
"0", "4", "0", "0", NA, "1", "", "1", "1", "2", "", "0", "median", 
"candidate", "0", "0", "1", "1", "0", "0", "0", "0", "0", "0", 
"5", "0.95"), domain = c(NA, NA, NA, NA, NA, NA, NA, NA, NA, 
NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, "F-test,t-test,t-test-holm,t-test-bonferroni", 
NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, 
NA, "sge,pbs,torque,slurm,htcondor", NA, NA, NA, NA, NA, NA, 
NA, NA, NA, NA, NA, "median,mean,worst,best", "instance,candidate", 
NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA), description = c("Show this help.", 
"Show irace package version.", "Check scenario.", "Initialize the working directory with template config files.", 
"Only test the configurations given in the file passed as argument.", 
"File that describes the configuration scenario setup and other irace settings.", 
"Directory where the programs will be run.", "File that contains the description of the parameters of the target algorithm.", 
"", "File that contains a list of logical expressions that cannot be TRUE for any evaluated configuration. If empty or NULL, do not use forbidden expressions.", 
"", "File that contains a table of initial configurations. If empty or NULL, all initial configurations are randomly generated.", 
"File to save tuning results as an R dataset, either absolute path or relative to execDir.", 
"Previously saved log file to recover the execution of irace, either absolute path or relative to the current directory.  If empty or NULL, recovery is not performed.", 
"", "Directory where training instances are located; either absolute path or relative to current directory. If no trainInstancesFiles is provided, all the files in trainInstancesDir will be listed as instances.", 
"File that contains a list of training instances and optionally additional parameters for them. If trainInstancesDir is provided, irace will search for the files in this folder.", 
"Randomly sample the training instances or use them in the order given.", 
"Directory where testing instances are located, either absolute or relative to current directory.", 
"File containing a list of test instances and optionally additional parameters for them.", 
"", "Number of elite configurations returned by irace that will be tested if test instances are provided.", 
"Enable/disable testing the elite configurations found at each iteration.", 
"Statistical test used for elimination. The default value selects t-test if capping is enabled or F-test, otherwise. Valid values are: F-test (Friedman test), t-test (pairwise t-tests with no correction), t-test-bonferroni (t-test with Bonferroni's correction for multiple comparisons), t-test-holm (t-test with Holm's correction for multiple comparisons).", 
"Number of instances evaluated before the first elimination test. It must be a multiple of eachTest.", 
"Number of instances evaluated between elimination tests.", "Executable called for each configuration that executes the target algorithm to be tuned. See the templates and examples provided.", 
"Executable that will be used to launch the target runner, when targetRunner cannot be executed directly (.e.g, a Python script in Windows).", 
"Command-line arguments provided to targetRunnerLauncher. The substrings \\{targetRunner\\} and \\{targetRunnerArgs\\} will be replaced by the value of the option targetRunner and by the arguments usually passed when calling targetRunner, respectively. Example: \"-m {targetRunner --args {targetRunnerArgs}\"}.", 
"Number of times to retry a call to targetRunner if the call failed.", 
"Optional data passed to targetRunner. This is ignored by the default targetRunner function, but it may be used by custom targetRunner functions to pass persistent data around.", 
"Optional R function to provide custom parallelization of targetRunner.", 
"Optional script or R function that provides a numeric value for each configuration. See templates/target-evaluator.tmpl", 
"If the target algorithm is deterministic, configurations will be evaluated only once per instance.", 
"Maximum number of runs (invocations of targetRunner) that will be performed. It determines the maximum budget of experiments for the tuning.", 
"Maximum total execution time in seconds for the executions of targetRunner. targetRunner must return two values: cost and time.", 
"Fraction (smaller than 1) of the budget used to estimate the mean computation time of a configuration. Only used when maxTime > 0", 
"Minimum time unit that is still (significantly) measureable.", 
"Number of calls to targetRunner to execute in parallel. Values 0 or 1 mean no parallelization.", 
"Enable/disable load-balancing when executing experiments in parallel. Load-balancing makes better use of computing resources, but increases communication overhead. If this overhead is large, disabling load-balancing may be faster.", 
"Enable/disable MPI. Use Rmpi to execute targetRunner in parallel (parameter parallel is the number of slaves).", 
"Specify how irace waits for jobs to finish when targetRunner submits jobs to a batch cluster: sge, pbs, torque, slurm or htcondor. targetRunner must submit jobs to the cluster using, for example, qsub.", 
"Maximum number of decimal places that are significant for numerical (real) parameters.", 
"Reduce the output generated by irace to a minimum.", "Debug level of the output of irace. Set this to 0 to silence all debug messages. Higher values provide more verbose debug messages.", 
"Seed of the random number generator (by default, generate a random seed).", 
"Enable/disable the soft restart strategy that avoids premature convergence of the probabilistic model.", 
"Soft restart threshold value for numerical parameters. If NA, NULL or \"\", it is computed as 10^-digits.", 
"Enable/disable elitist irace.", "Number of instances added to the execution list before previous instances in elitist irace.", 
"In elitist irace, maximum number per race of elimination tests that do not eliminate a configuration. Use 0 for no limit.", 
"User-defined R function that takes a configuration generated by irace and repairs it.", 
"Enable the use of adaptive capping, a technique designed for minimizing the computation time of configurations. This is only available when elitist is active.", 
"Measure used to obtain the execution bound from the performance of the elite configurations: median, mean, worst, best.", 
"Method to calculate the mean performance of elite configurations: candidate or instance.", 
"Maximum execution bound for targetRunner. It must be specified when capping is enabled.", 
"Precision used for calculating the execution time. It must be specified when capping is enabled.", 
"Penalization constant for timed out executions (executions that reach boundMax execution time).", 
"Replace the configuration cost of bounded executions with boundMax.", 
"Percentage of the configuration budget used to perform a postselection race of the best configurations of each iteration after the execution of irace.", 
"Enable/disable AClib mode. This option enables compatibility with GenericWrapper4AC as targetRunner script.", 
"Maximum number of iterations.", "Number of runs of the target algorithm per iteration.", 
"Minimum number of configurations needed to continue the execution of each race (iteration).", 
"Number of configurations to be sampled and evaluated at each iteration.", 
"Parameter used to define the number of configurations sampled and evaluated at each iteration.", 
"Confidence level for the elimination test.")), row.names = c(".help", 
".version", ".check", ".init", ".onlytest", "scenarioFile", "execDir", 
"parameterFile", "forbiddenExps", "forbiddenFile", "initConfigurations", 
"configurationsFile", "logFile", "recoveryFile", "instances", 
"trainInstancesDir", "trainInstancesFile", "sampleInstances", 
"testInstancesDir", "testInstancesFile", "testInstances", "testNbElites", 
"testIterationElites", "testType", "firstTest", "eachTest", "targetRunner", 
"targetRunnerLauncher", "targetRunnerLauncherArgs", "targetRunnerRetries", 
"targetRunnerData", "targetRunnerParallel", "targetEvaluator", 
"deterministic", "maxExperiments", "maxTime", "budgetEstimation", 
"minMeasurableTime", "parallel", "loadBalancing", "mpi", "batchmode", 
"digits", "quiet", "debugLevel", "seed", "softRestart", "softRestartThreshold", 
"elitist", "elitistNewInstances", "elitistLimit", "repairConfiguration", 
"capping", "cappingType", "boundType", "boundMax", "boundDigits", 
"boundPar", "boundAsTimeout", "postselection", "aclib", "nbIterations", 
"nbExperimentsPerIteration", "minNbSurvival", "nbConfigurations", 
"mu", "confidence"), class = "data.frame")
.irace.params.names <- c("scenarioFile", "execDir", "parameterFile", "forbiddenExps", 
"forbiddenFile", "initConfigurations", "configurationsFile", 
"logFile", "recoveryFile", "instances", "trainInstancesDir", 
"trainInstancesFile", "sampleInstances", "testInstancesDir", 
"testInstancesFile", "testInstances", "testNbElites", "testIterationElites", 
"testType", "firstTest", "eachTest", "targetRunner", "targetRunnerLauncher", 
"targetRunnerLauncherArgs", "targetRunnerRetries", "targetRunnerData", 
"targetRunnerParallel", "targetEvaluator", "deterministic", "maxExperiments", 
"maxTime", "budgetEstimation", "minMeasurableTime", "parallel", 
"loadBalancing", "mpi", "batchmode", "digits", "quiet", "debugLevel", 
"seed", "softRestart", "softRestartThreshold", "elitist", "elitistNewInstances", 
"elitistLimit", "repairConfiguration", "capping", "cappingType", 
"boundType", "boundMax", "boundDigits", "boundPar", "boundAsTimeout", 
"postselection", "aclib", "nbIterations", "nbExperimentsPerIteration", 
"minNbSurvival", "nbConfigurations", "mu", "confidence")
## FIXME: If these values are special perhaps they should be saved in $state ?
.irace.params.recover <- c("instances", "seed", "testInstances",
                           # We need this because this data may mutate
                           "targetRunnerData", "elitist", "deterministic")