Migrate nevergrad optimizers to new documentation style (#632)

gauravmanmode · web-flow · commit 54ca1bddb733 · 2026-01-23T11:19:22.000+01:00
diff --git a/.tools/envs/testenv-linux.yml b/.tools/envs/testenv-linux.yml
@@ -40,7 +40,6 @@ dependencies:
       - Py-BOBYQA  # dev, tests
       - fides==0.7.4  # dev, tests
       - kaleido>=1.0  # dev, tests
-      - bayes_optim  # dev, tests
       - gradient_free_optimizers  # dev, tests
       - pyswarms  # dev, tests
       - pandas-stubs  # dev, tests
diff --git a/.tools/envs/testenv-nevergrad.yml b/.tools/envs/testenv-nevergrad.yml
@@ -37,15 +37,14 @@ dependencies:
       - Py-BOBYQA  # dev, tests
       - fides==0.7.4  # dev, tests
       - kaleido>=1.0  # dev, tests
-      - bayes_optim  # dev, tests
       - gradient_free_optimizers  # dev, tests
       - pyswarms  # dev, tests
       - pandas-stubs  # dev, tests
       - types-cffi  # dev, tests
       - types-openpyxl  # dev, tests
       - types-jinja2  # dev, tests
       - sqlalchemy-stubs  # dev, tests
+      - sphinxcontrib-mermaid  # dev, tests, docs
       - bayesian_optimization==1.4.0
       - nevergrad
-      - sphinxcontrib-mermaid  # dev, tests, docs
       - -e ../../
diff --git a/.tools/envs/testenv-numpy.yml b/.tools/envs/testenv-numpy.yml
@@ -38,7 +38,6 @@ dependencies:
       - Py-BOBYQA  # dev, tests
       - fides==0.7.4  # dev, tests
       - kaleido>=1.0  # dev, tests
-      - bayes_optim  # dev, tests
       - gradient_free_optimizers  # dev, tests
       - pyswarms  # dev, tests
       - types-cffi  # dev, tests
diff --git a/.tools/envs/testenv-others.yml b/.tools/envs/testenv-others.yml
@@ -38,7 +38,6 @@ dependencies:
       - Py-BOBYQA  # dev, tests
       - fides==0.7.4  # dev, tests
       - kaleido>=1.0  # dev, tests
-      - bayes_optim  # dev, tests
       - gradient_free_optimizers  # dev, tests
       - pyswarms  # dev, tests
       - pandas-stubs  # dev, tests
diff --git a/.tools/envs/testenv-pandas.yml b/.tools/envs/testenv-pandas.yml
@@ -38,7 +38,6 @@ dependencies:
       - Py-BOBYQA  # dev, tests
       - fides==0.7.4  # dev, tests
       - kaleido>=1.0  # dev, tests
-      - bayes_optim  # dev, tests
       - gradient_free_optimizers  # dev, tests
       - pyswarms  # dev, tests
       - types-cffi  # dev, tests
diff --git a/.tools/envs/testenv-plotly.yml b/.tools/envs/testenv-plotly.yml
@@ -37,14 +37,13 @@ dependencies:
       - DFO-LS>=1.5.3  # dev, tests
       - Py-BOBYQA  # dev, tests
       - fides==0.7.4  # dev, tests
-      - bayes_optim  # dev, tests
       - gradient_free_optimizers  # dev, tests
       - pyswarms  # dev, tests
       - pandas-stubs  # dev, tests
       - types-cffi  # dev, tests
       - types-openpyxl  # dev, tests
       - types-jinja2  # dev, tests
       - sqlalchemy-stubs  # dev, tests
-      - kaleido<0.3
       - sphinxcontrib-mermaid  # dev, tests, docs
+      - kaleido<0.3
       - -e ../../
diff --git a/docs/source/algorithms.md b/docs/source/algorithms.md
diff --git a/docs/source/refs.bib b/docs/source/refs.bib
@@ -964,8 +964,8 @@ @inproceedings{tbpsaimpl
 year = {2016},
 month = {09},
 pages = {},
-title = {Evolution under Strong Noise: A Self-Adaptive Evolution Strategy Can Reach the Lower Performance Bound - the pcCMSA-ES},
-volume = {9921},
+title     = {Evolution under Strong Noise: A Self-Adaptive Evolution Strategy Can Reach the Lower Performance Bound - the pcCMSA-ES},
+booktitle = {Parallel Problem Solving from Nature -- PPSN XIII},volume = {9921},
 isbn = {9783319458229},
 doi = {10.1007/978-3-319-45823-6_3}
 }
@@ -1037,6 +1037,7 @@ @book{emnaimpl
 pages = {},
 title = {Estimation of Distribution Algorithms: A New Tool for Evolutionary Computation},
 isbn = {9781461356042},
+publisher = {Springer},
 journal = {Genetic algorithms and evolutionary computation ; 2},
 doi = {10.1007/978-1-4615-1539-5}
 }
diff --git a/environment.yml b/environment.yml
@@ -52,7 +52,6 @@ dependencies:
       - fides==0.7.4  # dev, tests
       - kaleido>=1.0  # dev, tests
       - pre-commit>=4  # dev
-      - bayes_optim  # dev, tests
       - gradient_free_optimizers  # dev, tests
       - pyswarms  # dev, tests
       - -e .  # dev
diff --git a/pyproject.toml b/pyproject.toml
@@ -383,6 +383,7 @@ module = [
     "pdbp",
     "iminuit",
     "nevergrad",
+    "nevergrad.optimization.base",
     "pygad",
     "pyswarms",
     "pyswarms.backend.topology",
diff --git a/src/optimagic/config.py b/src/optimagic/config.py
@@ -52,7 +52,17 @@ def _is_installed(module_name: str) -> bool:
 IS_NUMBA_INSTALLED = _is_installed("numba")
 IS_IMINUIT_INSTALLED = _is_installed("iminuit")
 IS_NEVERGRAD_INSTALLED = _is_installed("nevergrad")
-IS_BAYESOPT_INSTALLED = _is_installed("bayes_opt")
+# despite the similar names, the bayes_opt and bayes_optim packages are
+# completely unrelated. However, both of them are dependencies of nevergrad.
+IS_BAYESOPTIM_INSTALLED = _is_installed("bayes-optim")
+# Note: There is a dependancy conflict with nevergrad and bayesian_optimization
+# installing nevergrad pins bayesian_optimization to 1.4.0,
+# but "bayes_opt" requires bayesian_optimization>=2.0.0 to work.
+# so if nevergrad is installed, bayes_opt will not work and vice-versa.
+IS_BAYESOPT_INSTALLED_AND_VERSION_NEWER_THAN_2 = (
+    _is_installed("bayes_opt")
+    and importlib.metadata.version("bayesian_optimization") > "2.0.0"
+)
 IS_GRADIENT_FREE_OPTIMIZERS_INSTALLED = _is_installed("gradient_free_optimizers")
 IS_PYGAD_INSTALLED = _is_installed("pygad")
 IS_PYSWARMS_INSTALLED = _is_installed("pyswarms")
diff --git a/src/optimagic/optimizers/bayesian_optimizer.py b/src/optimagic/optimizers/bayesian_optimizer.py
@@ -10,7 +10,7 @@
 from scipy.optimize import NonlinearConstraint
 
 from optimagic import mark
-from optimagic.config import IS_BAYESOPT_INSTALLED
+from optimagic.config import IS_BAYESOPT_INSTALLED_AND_VERSION_NEWER_THAN_2
 from optimagic.exceptions import NotInstalledError
 from optimagic.optimization.algo_options import N_RESTARTS
 from optimagic.optimization.algorithm import Algorithm, InternalOptimizeResult
@@ -35,7 +35,7 @@
 @mark.minimizer(
     name="bayes_opt",
     solver_type=AggregationLevel.SCALAR,
-    is_available=IS_BAYESOPT_INSTALLED,
+    is_available=IS_BAYESOPT_INSTALLED_AND_VERSION_NEWER_THAN_2,
     is_global=True,
     needs_jac=False,
     needs_hess=False,
@@ -206,7 +206,7 @@ class BayesOpt(Algorithm):
     def _solve_internal_problem(
         self, problem: InternalOptimizationProblem, x0: NDArray[np.float64]
     ) -> InternalOptimizeResult:
-        if not IS_BAYESOPT_INSTALLED:
+        if not IS_BAYESOPT_INSTALLED_AND_VERSION_NEWER_THAN_2:
             raise NotInstalledError(
                 "To use the 'bayes_opt' optimizer you need to install bayes_opt. "
                 "Use 'pip install bayesian-optimization'. "
diff --git a/src/optimagic/optimizers/nevergrad_optimizers.py b/src/optimagic/optimizers/nevergrad_optimizers.py
diff --git a/tests/optimagic/optimization/test_infinite_and_incomplete_bounds.py b/tests/optimagic/optimization/test_infinite_and_incomplete_bounds.py
diff --git a/tests/optimagic/optimizers/test_bayesian_optimizer.py b/tests/optimagic/optimizers/test_bayesian_optimizer.py
