Skip to contents

Launching irace

irace()
Execute one run of the Iterated Racing algorithm.
irace.cmdline()
Launch irace with command-line options.
irace.main()
Higher-level interface to launch irace.
multi_irace()
Execute irace() multiple times with the same or different scenarios and parameter space definitions.
testing_fromfile()
Test configurations given an explicit table of configurations and a scenario file
testing_fromlog()
Test configurations given in .Rdata file

Analysis

getConfigurationById()
Returns the configurations selected by ID.
getConfigurationByIteration()
Returns the configurations by the iteration in which they were executed.
getFinalElites()
Return the elite configurations of the final iteration.
get_instanceID_seed_pairs()
Returns the pairs of instance IDs and seeds used as instances in the race (and optionally the actual instances).
irace_summarise()
Summarise the results of a run of irace
read_logfile()
Read the log file produced by irace (irace.Rdata).

Ablation

ablation()
Performs ablation between two configurations (from source to target).
ablation_cmdline()
Launch ablation with command-line options.
plotAblation()
Create plot from an ablation log
read_ablogfile()
Read the log file (log-ablation.Rdata) produced by ablation().

Other functions

cmdline_usage()
R6 Class for parsing command-line arguments
buildCommandLine()
Generate a command-line representation of a configuration
checkIraceScenario()
Test that the given irace scenario can be run.
checkParameters()
checkParameters
checkScenario()
Check and correct the given scenario
check_output_target_runner()
Check the output of the target runner and repair it if possible. If the output is incorrect, this function will throw an error.
configurations.print()
Print configurations as a data frame
configurations.print.command()
Print configurations as command-line strings.
defaultScenario()
Default scenario settings
has_testing_data()
Check if the results object generated by irace has data about the testing phase.
irace-package
The irace package: Iterated Racing for Automatic Algorithm Configuration
irace.license
irace.license
irace.version
A character string containing the version of irace including git SHA.
path_rel2abs()
Converts a relative path to an absolute path.
printParameters()
Print parameter space in the textual format accepted by irace.
printScenario()
Prints the given scenario
psRace()
psRace
get_random_seed() set_random_seed() restore_random_seed()
Get, set and restore the state of the random number generator state.
readConfigurationsFile()
Read parameter configurations from a file
readParameters()
Reads the parameters to be tuned by irace from a file or from a character string.
readScenario()
Reads from a file the scenario settings to be used by irace.
read_pcs_file()
Read parameters in PCS (AClib) format and write them in irace format.
removeConfigurationsMetaData()
removeConfigurationsMetaData
scenario_update_paths() scenario.update.paths()
Update filesystem paths of a scenario consistently.
target.evaluator.default()
target.evaluator.default
target.runner.default()
Default targetRunner function.
testConfigurations()
Execute the given configurations on the testing instances specified in the scenario