Make modular botorch config require Ax 0.3.5 and above

madeline-scyphers · Jul 22, 2024 · de06e69 · de06e69 · github-actions · Jul 22, 2024
1 parent 3d32571
commit de06e69
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/boa/config/converters.py b/boa/config/converters.py
@@ -15,6 +15,8 @@
 from ax.service.utils.instantiation import TParameterRepresentation
 from ax.service.utils.scheduler_options import SchedulerOptions
 
+from boa.utils import check_min_package_version
+
 if TYPE_CHECKING:
     from .config import BOAMetric
 
@@ -54,6 +56,12 @@ def _gen_strat_converter(gs: Optional[dict] = None) -> dict:
                 gs["steps"][i] = step
                 steps.append(step)
                 continue
+            if step["model"] == "BOTORCH_MODULAR" and not check_min_package_version("ax-platform", "0.3.5"):
+                raise ValueError(
+                    "BOTORCH_MODULAR model is not available in BOA with Ax version < 0.3.5. "
+                    "Please upgrade to a newer version of Ax."
+                )
+
             if "model_kwargs" in step:
                 if "botorch_acqf_class" in step["model_kwargs"] and not isinstance(
                     step["model_kwargs"]["botorch_acqf_class"], botorch.acquisition.AcquisitionFunction

diff --git a/tests/1unit_tests/test_generation_strategy.py b/tests/1unit_tests/test_generation_strategy.py
@@ -2,6 +2,7 @@
 import botorch.models
 import gpytorch.kernels
 import gpytorch.mlls
+import pytest
 from ax.modelbridge.generation_strategy import GenerationStep, GenerationStrategy
 from ax.modelbridge.registry import Models
 
@@ -47,6 +48,9 @@ def test_auto_gen_use_saasbo(saasbo_config, tmp_path):
         assert "FullyBayesian" in gs.name
 
 
+@pytest.importorskip(
+    "ax-platform", minversion="0.3.5", reason="BOTORCH_MODULAR model is not available in BOA with Ax version < 0.3.5."
+)
 def test_modular_botorch(gen_strat_modular_botorch_config, tmp_path):
     controller = Controller(
         config=gen_strat_modular_botorch_config,

diff --git a/tests/integration_tests/test_cli.py b/tests/integration_tests/test_cli.py
@@ -12,7 +12,6 @@
     get_trial_dir,
     load_jsonlike,
     scheduler_from_json_file,
-    scheduler_to_json_file,
     split_shell_command,
 )
 from boa.cli import main as cli_main
@@ -80,7 +79,20 @@ def test_calling_command_line_test_script_doesnt_error_out_and_produces_correct_
 # (which can customize the GP process even more)
 @pytest.mark.parametrize(
     "r_scripts_run",
-    ["r_full", "r_light", "r_streamlined", "r_streamlined_botorch_modular"],
+    [
+        "r_full",
+        "r_light",
+        "r_streamlined",
+        "r_streamlined_botorch_modular",
+        pytest.param(
+            "r_streamlined_botorch_modular",
+            marks=pytest.importorskip(
+                "ax-platform",
+                minversion="0.3.5",
+                reason="BOTORCH_MODULAR model is not available in BOA with Ax version < 0.3.5.",
+            ),
+        ),
+    ],
 )
 @pytest.mark.skipif(not R_INSTALLED, reason="requires R to be installed")
 def test_calling_command_line_r_test_scripts(r_scripts_run, request):
File	Stmts	Miss	Cover	Missing
__main__.py	5	5	0%	1–2, 7, 10–11
async_opt.py	105	18	82%	137, 181, 188, 191, 211–212, 218–219, 221–222, 224, 231–236, 240
ax_instantiation_utils.py	47	1	97%	120
controller.py	76	7	90%	73, 84, 176, 183–186
definitions.py	8	0	100%
instantiation_base.py	45	3	93%	24–25, 48
metaclasses.py	72	3	95%	50–51, 57
plot.py	12	12	0%	17, 19–20, 22–23, 26, 29, 36, 42–43, 46–47
plotting.py	141	28	80%	51–52, 59, 94–95, 251–253, 301–305, 345, 429–432, 434–441, 443, 448
registry.py	26	0	100%
runner.py	53	4	92%	54, 88–90
scheduler.py	81	14	82%	38, 128–131, 138–139, 153, 160–161, 168–169, 264–265
storage.py	124	15	87%	83, 115–117, 177, 195, 273–281
template.py	31	5	83%	52–56
utils.py	99	20	79%	179, 193–194, 219, 229–233, 235–237, 239, 241, 245–250
config
__main__.py	0	0	100%
config.py	307	34	88%	33, 211, 217, 221, 223–224, 226, 282, 409, 412, 420–421, 429, 603, 605, 607, 613–617, 619, 690, 723, 744, 751–752, 760, 773, 783–784, 796, 821, 824
converters.py	97	24	75%	21, 32, 51, 56–58, 60, 66, 69, 73–74, 77, 80, 83, 86, 89, 93, 97–98, 111, 113, 119, 127, 143
metrics
metric_funcs.py	34	4	88%	58, 80–81, 83
metrics.py	101	15	85%	127, 304–305, 310–311, 314, 320, 331–333, 337–341
modular_metric.py	138	24	82%	40–43, 45–52, 66, 137, 148, 172, 188, 197–198, 210, 265–266, 287–288
synthetic_funcs.py	39	4	89%	31, 35, 58, 65
scripts
moo.py	30	1	96%	44
run_branin.py	34	1	97%	56
script_wrappers.py	31	2	93%	57–58
synth_func_cli.py	21	0	100%
wrappers
base_wrapper.py	195	32	83%	63–64, 89–92, 94, 102, 110, 115, 132–133, 147, 156, 167, 215–216, 218, 267, 269, 271, 275, 330, 402, 416, 589, 591–594, 602, 612
script_wrapper.py	119	96	19%	64–66, 91–93, 182–193, 195–197, 199–200, 202–203, 205–208, 262–266, 271–276, 279–286, 309–315, 318, 320–324, 326–330, 332–333, 336–340, 343–355, 363–370, 372–373
synthetic_wrapper.py	16	2	87%	16, 28
wrapper_utils.py	150	30	80%	148–149, 247, 299, 415–434, 438–439, 448, 452–453, 456
TOTAL	2237	404	81%