cave.reader.smac2_reader module

class cave.reader.smac2_reader.SMAC2Reader(folder, ta_exec_dir)

Bases: cave.reader.base_reader.BaseReader

Reader for SMAC2-output. The expected output-structure in the specified folder is:

self.folder/

smac-output/

aclib/

state-run1/

• scenario.txt # scenario

• runs_and_results(…).csv # runhistory

• paramstrings(…).csv # runhistory

• traj-run-(…) # trajectory

validate-time-train/ # optional, if validation has been beformed

• validationCallStrings(…).csv

• validationRunResultLineMatrix(…).csv

validate-time-test/ # optional, if validation has been beformed

• validationCallStrings(…).csv

• validationRunResultLineMatrix(…).csv

classmethod check_for_files(path)

classmethod get_glob_file(folder, fn, raise_on_failure=True)

If a file is not found in the expected path structure, we can check if it’s unique in the subfolders and if so, return it.

get_runhistory(cs)

Expects the following files:

• self.folder/smac-output/aclib/state-run1/runs_and_results(…).csv

• self.folder/smac-output/aclib/state-run1/paramstrings(…).csv

Returns

rh – runhistory

Return type

RunHistory

get_scenario()

Expects self.folder/scenario.txt with appropriately formatted scenario-information (https://automl.github.io/SMAC3/stable/options.html#scenario)

get_trajectory(cs)

Expects the following files:

• self.folder/smac-output/aclib/state-run1/traj-run-(…).csv

get_validated_runhistory(cs)

Expects the following files:

• self.folder/validate-time-train/validationCallStrings(…).csv

• self.folder/validate-time-train/validationRunResultLineMatrix(…).csv

• self.folder/validate-time-test/validationCallStrings(…).csv

• self.folder/validate-time-test/validationRunResultLineMatrix(…).csv

Returns

validated_rh – validated runhistory

Return type

RunHistory