Return scenario with default values.
A list indexed by the irace parameter names, containing the default values for each parameter, except for those already present in the scenario passed as argument. The scenario list contains the following elements:
Path of the file that describes the configuration scenario setup and other irace settings. (Default:
Directory where the programs will be run. (Default:
File to save tuning results as an R dataset, either absolute path or relative to execDir. (Default:
Debug level of the output of
irace. Set this to 0 to silence all debug messages. Higher values provide more verbose debug messages. (Default:
Seed of the random number generator (by default, generate a random seed). (Default:
User-defined R function that takes a configuration generated by irace and repairs it. (Default:
Percentage of the configuration budget used to perform a postselection race of the best configurations of each iteration after the execution of irace. (Default:
Enable/disable AClib mode. This option enables compatibility with GenericWrapper4AC as targetRunner script. (Default:
Enable/disable elitist irace. (Default:
Number of instances added to the execution list before previous instances in elitist irace. (Default:
In elitist irace, maximum number per race of elimination tests that do not eliminate a configuration. Use 0 for no limit. (Default:
Number of iterations. (Default:
Number of runs of the target algorithm per iteration. (Default:
Randomly sample the training instances or use them in the order given. (Default:
Minimum number of configurations needed to continue the execution of each race (iteration). (Default:
Number of configurations to be sampled and evaluated at each iteration. (Default:
Parameter used to define the number of configurations sampled and evaluated at each iteration. (Default:
Enable/disable the soft restart strategy that avoids premature convergence of the probabilistic model. (Default:
Soft restart threshold value for numerical parameters. If
"", it is computed as
Target algorithm parameters:
File that contains the description of the parameters of the target algorithm. (Default:
Vector of R logical expressions that cannot evaluate to
TRUE for any evaluated configuration. (Default:
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. (Default:
Maximum number of decimal places that are significant for numerical (real) parameters. (Default:
Target algorithm execution:
Script called for each configuration that executes the target algorithm to be tuned. See templates. (Default:
Number of times to retry a call to
targetRunner if the call failed. (Default:
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. (Default:
Optional R function to provide custom parallelization of
Optional script or R function that provides a numeric value for each configuration. See templates/target-evaluator.tmpl (Default:
If the target algorithm is deterministic, configurations will be evaluated only once per instance. (Default:
Number of calls to
targetRunner to execute in parallel. Values
1 mean no parallelization. (Default:
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. (Default:
Enable/disable MPI. Use
Rmpi to execute
targetRunner in parallel (parameter
parallel is the number of slaves). (Default:
Specify how irace waits for jobs to finish when
targetRunner submits jobs to a batch cluster: sge, pbs, torque or slurm.
targetRunner must submit jobs to the cluster using, for example,
Data frame describing initial configurations (usually read from a file using
File that contains a table of initial configurations. If empty or
NULL, all initial configurations are randomly generated. (Default:
Character vector of the instances to be used in the
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. (Default:
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. (Default:
Maximum number of runs (invocations of
targetRunner) that will be performed. It determines the maximum budget of experiments for the tuning. (Default:
Maximum total execution time in seconds for the executions of
targetRunner must return two values: cost and time. (Default:
Fraction (smaller than 1) of the budget used to estimate the mean computation time of a configuration. Only used when
maxTime > 0 (Default:
Statistical test used for elimination. Default test is always
capping is enabled, in which case the default test is
t-test. 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). (Default:
Number of instances evaluated before the first elimination test. It must be a multiple of
Number of instances evaluated between elimination tests. (Default:
Confidence level for the elimination test. (Default:
Enable the use of adaptive capping, a technique designed for minimizing the computation time of configurations. This is only available when
elitist is active. (Default:
Measure used to obtain the execution bound from the performance of the elite configurations.
median: Median performance of the elite configurations.
mean: Mean performance of the elite configurations.
best: Best performance of the elite configurations.
worst: Worst performance of the elite configurations.
Method to calculate the mean performance of elite configurations.
candidate: Mean execution times across the executed instances and the current one.
instance: Execution time of the current instance.
Maximum execution bound for
targetRunner. It must be specified when capping is enabled. (Default:
Precision used for calculating the execution time. It must be specified when capping is enabled. (Default:
Penalization constant for timed out executions (executions that reach
boundMax execution time). (Default:
Replace the configuration cost of bounded executions with
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. (Default:
Directory where testing instances are located, either absolute or relative to current directory. (Default:
File containing a list of test instances and optionally additional parameters for them. (Default:
Character vector of the instances to be used in the
targetRunner when executing the testing. (Default:
Number of elite configurations returned by irace that will be tested if test instances are provided. (Default:
Enable/disable testing the elite configurations found at each iteration. (Default:
Manuel López-Ibáñez and Jérémie Dubois-Lacoste
for reading a configuration scenario from a file.
prints the given scenario.
returns the default scenario settings of irace.
to check that the scenario is valid.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.