Index

Symbols

--actual compute_marginal_contribution command line option, [1] --all cleanup command line option, [1] jobs command line option, [1] --best-configuration run_solvers command line option, [1] --cancel jobs command line option, [1] --configuration run_solvers command line option, [1] --configurator configure_solver command line option, [1] --cutoff-time run_parallel_portfolio command line option, [1] --deterministic add_solver command line option, [1] --download-examples initialise command line option, [1] --help about command line option, [1] add_feature_extractor command line option, [1] add_instances command line option, [1] add_solver command line option, [1] cleanup command line option, [1] compute_features command line option, [1] compute_marginal_contribution command line option, [1] configure_solver command line option, [1] construct_portfolio_selector command line option, [1] generate_report command line option, [1] initialise command line option, [1] jobs command line option, [1] load_snapshot command line option, [1] remove_feature_extractor command line option, [1] remove_instances command line option, [1] remove_solver command line option, [1] run_ablation command line option, [1] run_parallel_portfolio command line option, [1] run_portfolio_selector command line option, [1] run_solvers command line option, [1] save_snapshot command line option, [1] status command line option, [1] --instance run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --instance-path run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --instance-paths run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --instance-set run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --instance-set-path run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --instance-set-paths run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --instance-set-test configure_solver command line option, [1] generate_report command line option, [1] run_ablation command line option, [1] --instance-set-train configure_solver command line option, [1] generate_report command line option, [1] run_ablation command line option, [1] --instance-sets run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --instances run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --job-ids jobs command line option, [1] --name save_snapshot command line option, [1] --nickname add_feature_extractor command line option, [1] add_instances command line option, [1] add_solver command line option, [1] --no-ablation generate_report command line option, [1] --no-copy add_feature_extractor command line option, [1] add_instances command line option, [1] add_solver command line option, [1] --no-save initialise command line option, [1] --number-of-runs configure_solver command line option, [1] run_ablation command line option, [1] --objective construct_portfolio_selector command line option, [1] run_solvers command line option, [1] --objectives compute_marginal_contribution command line option, [1] configure_solver command line option, [1] generate_report command line option, [1] run_ablation command line option, [1] run_parallel_portfolio command line option, [1] --only-json generate_report command line option, [1] --perfect compute_marginal_contribution command line option, [1]

--performance-data cleanup command line option, [1] --performance-data-jobs run_solvers command line option, [1] --portfolio-name run_parallel_portfolio command line option, [1] --racing run_ablation command line option, [1] --rebuild-runsolver initialise command line option, [1] --recompute compute_features command line option, [1] run_solvers command line option, [1] --recompute-portfolio-selector construct_portfolio_selector command line option, [1] --remove cleanup command line option, [1] --run-on compute_features command line option, [1] configure_solver command line option, [1] construct_portfolio_selector command line option, [1] run_ablation command line option, [1] run_parallel_portfolio command line option, [1] run_portfolio_selector command line option, [1] run_solvers command line option, [1] --selection generate_report command line option, [1] --selector-timeout construct_portfolio_selector command line option, [1] --settings-file compute_features command line option, [1] compute_marginal_contribution command line option, [1] configure_solver command line option, [1] construct_portfolio_selector command line option, [1] generate_report command line option, [1] run_ablation command line option, [1] run_parallel_portfolio command line option, [1] run_portfolio_selector command line option, [1] run_solvers command line option, [1] --skip-checks add_solver command line option, [1] --solution-verifier add_solver command line option, [1] --solver configure_solver command line option, [1] generate_report command line option, [1] run_ablation command line option, [1] run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --solver-ablation construct_portfolio_selector command line option, [1] --solver-calls configure_solver command line option, [1] --solver-cutoff-time configure_solver command line option, [1] run_ablation command line option, [1] run_solvers command line option, [1] --solver-path run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --solver-paths run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --solver-seeds run_parallel_portfolio command line option, [1] --solvers run_parallel_portfolio command line option, [1] run_solvers command line option, [1] --target-cutoff-time configure_solver command line option, [1] run_ablation command line option, [1] run_solvers command line option, [1] --test-case-directory generate_report command line option, [1] --test-set-run-all-configurations configure_solver command line option, [1] --use-features configure_solver command line option, [1] --verbose status command line option, [1] --wallclock-time run_ablation command line option, [1] -h about command line option, [1] add_feature_extractor command line option, [1] add_instances command line option, [1] add_solver command line option, [1] cleanup command line option, [1] compute_features command line option, [1] compute_marginal_contribution command line option, [1] configure_solver command line option, [1] construct_portfolio_selector command line option, [1] generate_report command line option, [1] initialise command line option, [1] jobs command line option, [1] load_snapshot command line option, [1] remove_feature_extractor command line option, [1] remove_instances command line option, [1] remove_solver command line option, [1] run_ablation command line option, [1] run_parallel_portfolio command line option, [1] run_portfolio_selector command line option, [1] run_solvers command line option, [1] save_snapshot command line option, [1] status command line option, [1] -v status command line option, [1]

_

_check_class() (in module sparkle.types)

A

AblationScenario (class in sparkle.configurator) about command line option --help, [1] -h, [1] add_extractor() (sparkle.structures.FeatureDataFrame method) add_feature_extractor command line option --help, [1] --nickname, [1] --no-copy, [1] -h, [1] extractor-path, [1] add_instance() (sparkle.structures.PerformanceDataFrame method) add_instances command line option --help, [1] --nickname, [1] --no-copy, [1] -h, [1] instances-path, [1]

add_instances() (sparkle.structures.FeatureDataFrame method) add_objective() (sparkle.structures.PerformanceDataFrame method) add_runs() (sparkle.structures.PerformanceDataFrame method) add_slurm_extra_option() (sparkle.platform.Settings method) add_solver command line option --deterministic, [1] --help, [1] --nickname, [1] --no-copy, [1] --skip-checks, [1] --solution-verifier, [1] -h, [1] solver-path, [1] add_solver() (sparkle.structures.PerformanceDataFrame method) all_paths (sparkle.instance.InstanceSet property) (sparkle.instance.MultiFileInstanceSet property)

B

best_configuration() (sparkle.structures.PerformanceDataFrame method) best_instance_performance() (sparkle.structures.PerformanceDataFrame method) best_performance() (sparkle.structures.PerformanceDataFrame method) build_cmd() (sparkle.solver.Extractor method) (sparkle.solver.Selector method) (sparkle.solver.Solver method) (sparkle.types.SparkleCallable method)

build_construction_cmd() (sparkle.solver.Selector method)

C

call_sat_raw_result() (sparkle.solver.SATVerifier static method) check_for_ablation() (sparkle.configurator.AblationScenario method) check_settings_changes() (sparkle.platform.Settings static method) check_validity() (sparkle.tools.PCSParser method) clean_csv() (sparkle.structures.PerformanceDataFrame method) cleanup command line option --all, [1] --help, [1] --performance-data, [1] --remove, [1] -h, [1] clone() (sparkle.structures.PerformanceDataFrame method) compute_features command line option --help, [1] --recompute, [1] --run-on, [1] --settings-file, [1] -h, [1] compute_marginal_contribution command line option --actual, [1] --help, [1] --objectives, [1] --perfect, [1] --settings-file, [1] -h, [1] config_str_to_dict() (sparkle.solver.Solver static method) configuration_performance() (sparkle.structures.PerformanceDataFrame method) ConfigurationScenario (class in sparkle.configurator) Configurator (class in sparkle.configurator) configure() (sparkle.configurator.Configurator method)

configure_solver command line option --configurator, [1] --help, [1] --instance-set-test, [1] --instance-set-train, [1] --number-of-runs, [1] --objectives, [1] --run-on, [1] --settings-file, [1] --solver, [1] --solver-calls, [1] --solver-cutoff-time, [1] --target-cutoff-time, [1] --test-set-run-all-configurations, [1] --use-features, [1] -h, [1] construct() (sparkle.solver.Selector method) construct_portfolio_selector command line option --help, [1] --objective, [1] --recompute-portfolio-selector, [1] --run-on, [1] --selector-timeout, [1] --settings-file, [1] --solver-ablation, [1] -h, [1] create_configuration_file() (sparkle.configurator.AblationScenario method) create_instance_file() (sparkle.configurator.AblationScenario method) create_scenario() (sparkle.configurator.ConfigurationScenario method) create_scenario_file() (sparkle.configurator.ConfigurationScenario method)

E

export() (sparkle.tools.PCSParser method) Extractor (class in sparkle.solver) extractor-path add_feature_extractor command line option, [1] remove_feature_extractor command line option, [1]

extractors (sparkle.structures.FeatureDataFrame property)

F

feature_groups (sparkle.solver.Extractor property) FeatureDataFrame (class in sparkle.structures) FeatureGroup (class in sparkle.types) features (sparkle.solver.Extractor property)

FeatureSubgroup (class in sparkle.types) FeatureType (class in sparkle.types) FileInstanceSet (class in sparkle.instance) find_scenario() (sparkle.configurator.ConfigurationScenario class method) from_file() (sparkle.configurator.ConfigurationScenario static method)

G

generate_report command line option --help, [1] --instance-set-test, [1] --instance-set-train, [1] --no-ablation, [1] --objectives, [1] --only-json, [1] --selection, [1] --settings-file, [1] --solver, [1] --test-case-directory, [1] -h, [1] get_ablation_racing_flag() (sparkle.platform.Settings method) get_configspace() (sparkle.solver.Solver method) (sparkle.tools.PCSParser method) get_configurator_max_iterations() (sparkle.platform.Settings method) get_configurator_number_of_runs() (sparkle.platform.Settings method) get_configurator_settings() (sparkle.platform.Settings method) get_configurator_solver_calls() (sparkle.platform.Settings method) get_feature_groups() (sparkle.structures.FeatureDataFrame method) get_feature_vector() (sparkle.solver.Extractor method) get_forbidden() (sparkle.solver.Solver method) get_general_check_interval() (sparkle.platform.Settings method) get_general_extractor_cutoff_time() (sparkle.platform.Settings method) get_general_sparkle_configurator() (sparkle.platform.Settings method) get_general_sparkle_objectives() (sparkle.platform.Settings method) get_general_sparkle_selector() (sparkle.platform.Settings method) get_general_target_cutoff_time() (sparkle.platform.Settings method) get_general_verbosity() (sparkle.platform.Settings method) get_instance() (sparkle.structures.FeatureDataFrame method) get_instance_num_runs() (sparkle.structures.PerformanceDataFrame method) get_irace_first_test() (sparkle.platform.Settings method) get_irace_max_experiments() (sparkle.platform.Settings method) get_irace_max_iterations() (sparkle.platform.Settings method) get_irace_max_time() (sparkle.platform.Settings method) get_irace_mu() (sparkle.platform.Settings method) get_job_list() (sparkle.structures.PerformanceDataFrame method)

get_measurements() (sparkle.tools.RunSolver static method) get_number_of_jobs_in_parallel() (sparkle.platform.Settings method) get_parallel_portfolio_check_interval() (sparkle.platform.Settings method) get_parallel_portfolio_number_of_seeds_per_solver() (sparkle.platform.Settings method) get_path_by_name() (sparkle.instance.InstanceSet method) get_pcs() (sparkle.solver.Solver method) get_pcs_file() (sparkle.solver.Solver method) get_run_on() (sparkle.platform.Settings method) get_slurm_extra_options() (sparkle.platform.Settings method) get_slurm_max_parallel_runs_per_node() (sparkle.platform.Settings method) get_smac2_cli_cores() (sparkle.platform.Settings method) get_smac2_cpu_time() (sparkle.platform.Settings method) get_smac2_max_iterations() (sparkle.platform.Settings method) get_smac2_target_cutoff_length() (sparkle.platform.Settings method) get_smac2_use_cpu_time_in_tunertime() (sparkle.platform.Settings method) get_smac2_wallclock_time() (sparkle.platform.Settings method) get_smac3_cputime_limit() (sparkle.platform.Settings method) get_smac3_crash_cost() (sparkle.platform.Settings method) get_smac3_facade_max_ratio() (sparkle.platform.Settings method) get_smac3_max_budget() (sparkle.platform.Settings method) get_smac3_min_budget() (sparkle.platform.Settings method) get_smac3_number_of_trials() (sparkle.platform.Settings method) get_smac3_smac_facade() (sparkle.platform.Settings method) get_smac3_termination_cost_threshold() (sparkle.platform.Settings method) get_smac3_use_default_config() (sparkle.platform.Settings method) get_smac3_walltime_limit() (sparkle.platform.Settings method) get_solver_args() (sparkle.tools.RunSolver static method) get_solver_call_params() (in module sparkle.tools) get_solver_output() (sparkle.tools.RunSolver static method) get_solver_ranking() (sparkle.structures.PerformanceDataFrame method) get_status() (sparkle.tools.RunSolver static method) get_status_from_logs() (sparkle.configurator.Configurator method) get_time_pid_random_string() (in module sparkle.tools) get_value() (sparkle.structures.FeatureDataFrame method) (sparkle.structures.PerformanceDataFrame method) get_values() (sparkle.structures.PerformanceDataFrame method) groupwise_computation (sparkle.solver.Extractor property)

H

has_missing_value() (sparkle.structures.FeatureDataFrame method)

has_missing_values (sparkle.structures.PerformanceDataFrame property) has_missing_vectors() (sparkle.structures.FeatureDataFrame method)

I

impute_missing_values() (sparkle.structures.FeatureDataFrame method) initialise command line option --download-examples, [1] --help, [1] --no-save, [1] --rebuild-runsolver, [1] -h, [1] instance_names (sparkle.instance.InstanceSet property) instance_path run_portfolio_selector command line option, [1]

instance_paths (sparkle.instance.InstanceSet property) Instance_Set() (in module sparkle.instance) instances (sparkle.structures.FeatureDataFrame property) (sparkle.structures.PerformanceDataFrame property) instances-path add_instances command line option, [1] remove_instances command line option, [1] InstanceSet (class in sparkle.instance) IterableFileInstanceSet (class in sparkle.instance)

J

jobs command line option --all, [1] --cancel, [1] --help, [1] --job-ids, [1] -h, [1]

L

load() (sparkle.tools.PCSParser method) load_snapshot command line option --help, [1] -h, [1] snapshot-file-path, [1]

M

marginal_contribution() (sparkle.structures.PerformanceDataFrame method) mean() (sparkle.structures.PerformanceDataFrame method) module sparkle.about sparkle.CLI sparkle.configurator sparkle.instance sparkle.platform sparkle.solver sparkle.structures sparkle.tools sparkle.types

multi_objective (sparkle.structures.PerformanceDataFrame property) MultiFileInstanceSet (class in sparkle.instance)

N

name (sparkle.instance.FileInstanceSet property) (sparkle.instance.InstanceSet property) num_features (sparkle.structures.FeatureDataFrame property)

num_instances (sparkle.structures.PerformanceDataFrame property) num_objectives (sparkle.structures.PerformanceDataFrame property) num_runs (sparkle.structures.PerformanceDataFrame property) num_solvers (sparkle.structures.PerformanceDataFrame property)

O

objective_names (sparkle.structures.PerformanceDataFrame property) objectives (sparkle.structures.PerformanceDataFrame property)

organise_output() (sparkle.configurator.Configurator static method) output_dimension (sparkle.solver.Extractor property)

P

parse_solver_output() (sparkle.solver.Solver static method) PCSParser (class in sparkle.tools)

PerformanceDataFrame (class in sparkle.structures) port_pcs() (sparkle.solver.Solver method) process_predict_schedule_output() (sparkle.solver.Selector static method)

R

read_ablation_table() (sparkle.configurator.AblationScenario method) read_pcs_file() (sparkle.solver.Solver method) read_settings_ini() (sparkle.platform.Settings method) remaining_jobs() (sparkle.structures.FeatureDataFrame method) (sparkle.structures.PerformanceDataFrame method) remove_empty_runs() (sparkle.structures.PerformanceDataFrame method) remove_extractor() (sparkle.structures.FeatureDataFrame method) remove_feature_extractor command line option --help, [1] -h, [1] extractor-path, [1] remove_instance() (sparkle.structures.PerformanceDataFrame method) remove_instances command line option --help, [1] -h, [1] instances-path, [1] remove_instances() (sparkle.structures.FeatureDataFrame method) remove_runs() (sparkle.structures.PerformanceDataFrame method) remove_solver command line option --help, [1] -h, [1] solver, [1] remove_solver() (sparkle.structures.PerformanceDataFrame method) reset_dataframe() (sparkle.structures.FeatureDataFrame method) reset_value() (sparkle.structures.PerformanceDataFrame method) resolve_objective() (in module sparkle.types) run() (sparkle.solver.Extractor method) (sparkle.solver.Selector method) (sparkle.solver.Solver method) (sparkle.types.SparkleCallable method) run_ablation command line option --help, [1] --instance-set-test, [1] --instance-set-train, [1] --number-of-runs, [1] --objectives, [1] --racing, [1] --run-on, [1] --settings-file, [1] --solver, [1] --solver-cutoff-time, [1] --target-cutoff-time, [1] --wallclock-time, [1] -h, [1] run_ids (sparkle.structures.PerformanceDataFrame property) run_parallel_portfolio command line option --cutoff-time, [1] --help, [1] --instance, [1] --instance-path, [1] --instance-paths, [1] --instance-set, [1] --instance-set-path, [1] --instance-set-paths, [1] --instance-sets, [1] --instances, [1] --objectives, [1] --portfolio-name, [1] --run-on, [1] --settings-file, [1] --solver, [1] --solver-path, [1] --solver-paths, [1] --solver-seeds, [1] --solvers, [1] -h, [1]

run_performance_dataframe() (sparkle.solver.Solver method) run_portfolio_selector command line option --help, [1] --run-on, [1] --settings-file, [1] -h, [1] instance_path, [1] run_solvers command line option --best-configuration, [1] --configuration, [1] --help, [1] --instance, [1] --instance-path, [1] --instance-paths, [1] --instance-set, [1] --instance-set-path, [1] --instance-set-paths, [1] --instance-sets, [1] --instances, [1] --objective, [1] --performance-data-jobs, [1] --recompute, [1] --run-on, [1] --settings-file, [1] --solver, [1] --solver-cutoff-time, [1] --solver-path, [1] --solver-paths, [1] --solvers, [1] --target-cutoff-time, [1] -h, [1] RunSolver (class in sparkle.tools)

S

sat_verify_output() (sparkle.solver.SATVerifier static method) SATVerifier (class in sparkle.solver) save_csv() (sparkle.structures.FeatureDataFrame method) (sparkle.structures.PerformanceDataFrame method) save_snapshot command line option --help, [1] --name, [1] -h, [1] scenario_class() (sparkle.configurator.Configurator static method) schedule_performance() (sparkle.structures.PerformanceDataFrame method) Selector (class in sparkle.solver) serialize() (sparkle.configurator.ConfigurationScenario method) set_ablation_racing_flag() (sparkle.platform.Settings method) set_configurator_max_iterations() (sparkle.platform.Settings method) set_configurator_number_of_runs() (sparkle.platform.Settings method) set_configurator_solver_calls() (sparkle.platform.Settings method) set_general_check_interval() (sparkle.platform.Settings method) set_general_extractor_cutoff_time() (sparkle.platform.Settings method) set_general_sparkle_configurator() (sparkle.platform.Settings method) set_general_sparkle_objectives() (sparkle.platform.Settings method) set_general_sparkle_selector() (sparkle.platform.Settings method) set_general_target_cutoff_time() (sparkle.platform.Settings method) set_general_verbosity() (sparkle.platform.Settings method) set_irace_first_test() (sparkle.platform.Settings method) set_irace_max_experiments() (sparkle.platform.Settings method) set_irace_max_iterations() (sparkle.platform.Settings method) set_irace_max_time() (sparkle.platform.Settings method) set_irace_mu() (sparkle.platform.Settings method) set_number_of_jobs_in_parallel() (sparkle.platform.Settings method) set_parallel_portfolio_check_interval() (sparkle.platform.Settings method) set_parallel_portfolio_number_of_seeds_per_solver() (sparkle.platform.Settings method) set_run_on() (sparkle.platform.Settings method) set_slurm_max_parallel_runs_per_node() (sparkle.platform.Settings method) set_smac2_cli_cores() (sparkle.platform.Settings method) set_smac2_cpu_time() (sparkle.platform.Settings method) set_smac2_max_iterations() (sparkle.platform.Settings method) set_smac2_target_cutoff_length() (sparkle.platform.Settings method) set_smac2_use_cpu_time_in_tunertime() (sparkle.platform.Settings method) set_smac2_wallclock_time() (sparkle.platform.Settings method) set_smac3_cputime_limit() (sparkle.platform.Settings method) set_smac3_crash_cost() (sparkle.platform.Settings method) set_smac3_facade_max_ratio() (sparkle.platform.Settings method) set_smac3_max_budget() (sparkle.platform.Settings method) set_smac3_min_budget() (sparkle.platform.Settings method) set_smac3_number_of_trials() (sparkle.platform.Settings method) set_smac3_smac_facade() (sparkle.platform.Settings method) set_smac3_termination_cost_threshold() (sparkle.platform.Settings method)

set_smac3_use_default_config() (sparkle.platform.Settings method) set_smac3_walltime_limit() (sparkle.platform.Settings method) set_value() (sparkle.structures.FeatureDataFrame method) (sparkle.structures.PerformanceDataFrame method) Settings (class in sparkle.platform) SettingState (class in sparkle.platform) size (sparkle.instance.InstanceSet property) (sparkle.instance.IterableFileInstanceSet property) SlurmBatch (class in sparkle.tools) snapshot-file-path load_snapshot command line option, [1] SolutionVerifier (class in sparkle.solver) solver remove_solver command line option, [1] Solver (class in sparkle.solver) solver-path add_solver command line option, [1] solvers (sparkle.structures.PerformanceDataFrame property) SolverStatus (class in sparkle.types) sort() (sparkle.structures.FeatureDataFrame method) sparkle.about module sparkle.CLI module sparkle.configurator module sparkle.instance module sparkle.platform module sparkle.solver module sparkle.structures module sparkle.tools module sparkle.types module SparkleCallable (class in sparkle.types) SparkleObjective (class in sparkle.types) status command line option --help, [1] --verbose, [1] -h, [1] -v, [1] stem (sparkle.types.SparkleObjective property) submit_ablation() (sparkle.configurator.AblationScenario method)

T

time (sparkle.types.SparkleObjective property)

to_autofolio() (sparkle.structures.FeatureDataFrame method) (sparkle.structures.PerformanceDataFrame method)

U

UseTime (class in sparkle.types)

V

verify() (sparkle.solver.SATVerifier static method) (sparkle.solver.SolutionVerifier method)

verify_indexing() (sparkle.structures.PerformanceDataFrame method) verify_objective() (sparkle.structures.PerformanceDataFrame method) verify_run_id() (sparkle.structures.PerformanceDataFrame method)

W

with_subgroup() (sparkle.types.FeatureType static method) wrap_command() (sparkle.tools.RunSolver static method)

write_settings_ini() (sparkle.platform.Settings method) write_used_settings() (sparkle.platform.Settings method)