Coverage for sparkle/CLI/add_instances.py: 0%
66 statements
« prev ^ index » next coverage.py v7.6.1, created at 2024-09-27 09:10 +0000
« prev ^ index » next coverage.py v7.6.1, created at 2024-09-27 09:10 +0000
1#!/usr/bin/env python3
2"""Sparkle command to add an instance set to the Sparkle platform."""
4import sys
5import argparse
6from pathlib import Path
7import shutil
9from sparkle.CLI.help import global_variables as gv
10from sparkle.platform import file_help as sfh
11from sparkle.platform.settings_objects import SettingState
12from sparkle.instance import instance_set
13from sparkle.structures import FeatureDataFrame, PerformanceDataFrame
14from sparkle.CLI.compute_features import compute_features
15from sparkle.CLI.run_solvers import running_solvers_performance_data
16from sparkle.CLI.help import logging as sl
17from sparkle.platform import CommandName, COMMAND_DEPENDENCIES
18from sparkle.CLI.initialise import check_for_initialise
19from sparkle.CLI.help import argparse_custom as ac
22def parser_function() -> argparse.ArgumentParser:
23 """Define the command line arguments."""
24 parser = argparse.ArgumentParser()
25 parser.add_argument(*ac.InstancesPathArgument.names,
26 **ac.InstancesPathArgument.kwargs)
27 parser.add_argument(*ac.RunExtractorNowArgument.names,
28 **ac.RunExtractorNowArgument.kwargs)
29 parser.add_argument(*ac.RunSolverNowArgument.names,
30 **ac.RunSolverNowArgument.kwargs)
31 parser.add_argument(*ac.NicknameInstanceSetArgument.names,
32 **ac.NicknameInstanceSetArgument.kwargs)
33 parser.add_argument(*ac.RunOnArgument.names,
34 **ac.RunOnArgument.kwargs)
36 return parser
39if __name__ == "__main__":
40 # Log command call
41 sl.log_command(sys.argv)
43 # Define command line arguments
44 parser = parser_function()
46 # Process command line arguments
47 args = parser.parse_args()
48 instances_source = Path(args.instances_path)
49 instances_target = gv.settings().DEFAULT_instance_dir / instances_source.name
51 if args.run_on is not None:
52 gv.settings().set_run_on(
53 args.run_on.value, SettingState.CMD_LINE)
54 run_on = gv.settings().get_run_on()
56 check_for_initialise(COMMAND_DEPENDENCIES[CommandName.ADD_INSTANCES])
58 if not instances_source.exists():
59 print(f'Instance set path "{instances_source}" does not exist!')
60 sys.exit(-1)
61 if instances_target.exists():
62 print(f'Instance set "{instances_source.name}" already exists in Sparkle! '
63 "Exiting...")
64 sys.exit(-1)
65 if args.nickname is not None:
66 sfh.add_remove_platform_item(instances_target,
67 gv.instances_nickname_path, key=args.nickname)
69 print(f"Start adding all instances in directory {instances_source} ...")
70 new_instance_set = instance_set(instances_source)
72 instances_target.mkdir(parents=True)
73 print("Copying files...")
74 for instance_path_source in new_instance_set.all_paths:
75 print(f"Copying {instance_path_source} to {instances_target}...", end="\r")
76 shutil.copy(instance_path_source, instances_target)
77 print("\nCopying done!")
78 # Refresh the instance set as the target instance set
79 new_instance_set = instance_set(instances_target)
81 # Add the instances to the Feature Data / Performance Data
82 feature_data = FeatureDataFrame(gv.settings().DEFAULT_feature_data_path)
83 # When adding instances, an empty performance DF has no objectives yet
84 performance_data = PerformanceDataFrame(
85 gv.settings().DEFAULT_performance_data_path,
86 objectives=gv.settings().get_general_sparkle_objectives())
87 for instance_path in new_instance_set.instance_paths:
88 # Construct a name path due to multi-file instances
89 feature_data.add_instances(str(instance_path))
90 performance_data.add_instance(str(instance_path))
91 feature_data.save_csv()
92 performance_data.save_csv()
94 print(f"\nAdding instance set {new_instance_set.name} done!")
96 if args.run_extractor_now:
97 print("Start computing features ...")
98 compute_features(gv.settings().DEFAULT_feature_data_path, False)
100 if args.run_solver_now:
101 num_job_in_parallel = gv.settings().get_number_of_jobs_in_parallel()
102 running_solvers_performance_data(gv.settings().DEFAULT_performance_data_path,
103 num_job_in_parallel,
104 rerun=False, run_on=run_on)
105 print("Running solvers...")
107 # Write used settings to file
108 gv.settings().write_used_settings()