alib.run_experiment

exception alib.run_experiment.AlibExecutionError
class alib.run_experiment.CustomizedDataManager(address=None, authkey=None, serializer='pickle')
ScenarioParameterContainer(*args, **kwds)
ScenarioSolutionStorage(*args, **kwds)
class alib.run_experiment.ExecutionParameters(execution_parameter_space)

Container to store execution parameters (and expand to multiple execution parameters)

generate_parameter_combinations()

Investigates the given dictionary structure and constructs the cartesian product of all parameters.

Returns:
get_execution_ids(**kwargs)

returns (suitable) execution ids filtered by **kwargs

Parameters:kwargs –
Returns:
class alib.run_experiment.ExperimentExecution(min_scenario_index, max_scenario_index, concurrent=1, shuffle_instances=True, overwrite_existing_temporary_scenarios=False, overwrite_existing_intermediate_solutions=False, remove_temporary_scenarios=False, remove_intermediate_solutions=False)

Handles the execution of experiments: slices scenario space and uses multiprocessing to obtain results.

clean_up()
setup(execution_parameter_container, scenario_picklefile)
start_experiment()
alib.run_experiment.register_algorithm(alg_id, alg_class)
alib.run_experiment.run_experiment(experiment_yaml_file, min_scenario_index, max_scenario_index, concurrent, shuffle_instances=True, overwrite_existing_temporary_scenarios=False, overwrite_existing_intermediate_solutions=False, remove_temporary_scenarios=False, remove_intermediate_solutions=False)

Entry point for running experiments.

Parameters:
  • experiment_yaml_file – the yaml file detailing algorithm parameters / settings
  • min_scenario_index – the minimal scenario index that shall be included in the execution
  • max_scenario_index – the maximal scenario index that shall be included in the execution
  • concurrent – the number of processes (!= threads: each process may use multiple threads) to execute the experiments
  • shuffle_instances – shall the instances be shuffled (deterministically) to better mix of hard and simple instances
  • overwrite_existing_intermediate_scenario_pickles – shall existing scenario pickle files be replaced?
  • read_existing_intermediate_solutions_from_file – shall existing intermediate solution files be used or shall instance solutions be recomputed?
  • remove_temporary_scenarios – shall temporary scenario files be removed after execution?
  • remove_intermediate_solutions – shall intermediate solution files be removed after execution?
Returns: