Which Optimizer to Choose (#536)

optimagic-dev · Nov 5, 2024 · 7cb7710 · 7cb7710
1 parent cc049d1
commit 7cb7710
Show file tree

Hide file tree

Showing 11 changed files with 249 additions and 63 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -68,7 +68,7 @@ repos:
           - --blank
         exclude: src/optimagic/optimization/algo_options.py
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.1
+    rev: v0.7.2
     hooks:
       # Run the linter.
       - id: ruff
@@ -108,7 +108,7 @@ repos:
           - '88'
         files: (docs/.)
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.7.1
+    rev: 0.8.0
     hooks:
       - id: nbstripout
         exclude: |

diff --git a/.tools/envs/testenv-linux.yml b/.tools/envs/testenv-linux.yml
@@ -8,7 +8,7 @@ dependencies:
   - jax
   - cyipopt>=1.4.0  # dev, tests
   - pygmo>=2.19.0  # dev, tests
-  - nlopt  # dev, tests
+  - nlopt  # dev, tests, docs
   - pip  # dev, tests, docs
   - pytest  # dev, tests
   - pytest-cov  # tests
@@ -37,4 +37,5 @@ dependencies:
       - types-openpyxl  # dev, tests
       - types-jinja2  # dev, tests
       - sqlalchemy-stubs  # dev, tests
+      - sphinxcontrib-mermaid  # dev, tests, docs
       - -e ../../
diff --git a/.tools/envs/testenv-numpy.yml b/.tools/envs/testenv-numpy.yml
@@ -8,7 +8,7 @@ dependencies:
   - numpy<2
   - cyipopt>=1.4.0  # dev, tests
   - pygmo>=2.19.0  # dev, tests
-  - nlopt  # dev, tests
+  - nlopt  # dev, tests, docs
   - pip  # dev, tests, docs
   - pytest  # dev, tests
   - pytest-cov  # tests
@@ -34,4 +34,5 @@ dependencies:
       - types-openpyxl  # dev, tests
       - types-jinja2  # dev, tests
       - sqlalchemy-stubs  # dev, tests
+      - sphinxcontrib-mermaid  # dev, tests, docs
       - -e ../../
diff --git a/.tools/envs/testenv-others.yml b/.tools/envs/testenv-others.yml
@@ -6,7 +6,7 @@ channels:
 dependencies:
   - cyipopt>=1.4.0  # dev, tests
   - pygmo>=2.19.0  # dev, tests
-  - nlopt  # dev, tests
+  - nlopt  # dev, tests, docs
   - pip  # dev, tests, docs
   - pytest  # dev, tests
   - pytest-cov  # tests
@@ -35,4 +35,5 @@ dependencies:
       - types-openpyxl  # dev, tests
       - types-jinja2  # dev, tests
       - sqlalchemy-stubs  # dev, tests
+      - sphinxcontrib-mermaid  # dev, tests, docs
       - -e ../../
diff --git a/.tools/envs/testenv-pandas.yml b/.tools/envs/testenv-pandas.yml
@@ -8,7 +8,7 @@ dependencies:
   - numpy<2
   - cyipopt>=1.4.0  # dev, tests
   - pygmo>=2.19.0  # dev, tests
-  - nlopt  # dev, tests
+  - nlopt  # dev, tests, docs
   - pip  # dev, tests, docs
   - pytest  # dev, tests
   - pytest-cov  # tests
@@ -34,4 +34,5 @@ dependencies:
       - types-openpyxl  # dev, tests
       - types-jinja2  # dev, tests
       - sqlalchemy-stubs  # dev, tests
+      - sphinxcontrib-mermaid  # dev, tests, docs
       - -e ../../
diff --git a/docs/rtd_environment.yml b/docs/rtd_environment.yml
@@ -27,6 +27,7 @@ dependencies:
   - patsy
   - joblib
   - plotly
+  - nlopt
   - annotated-types
   - pip:
       - ../
@@ -38,3 +39,5 @@ dependencies:
       - types-openpyxl  # dev, tests
       - types-jinja2  # dev, tests
       - sqlalchemy-stubs  # dev, tests
+      - sphinxcontrib-mermaid  # dev, tests, docs
+      - fides==0.7.4  # dev, tests
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -48,13 +48,17 @@
     "sphinxcontrib.bibtex",
     "sphinx_panels",
     "sphinx_design",
+    "sphinxcontrib.mermaid",
 ]
 
 myst_enable_extensions = [
     "colon_fence",
     "dollarmath",
     "html_image",
 ]
+myst_fence_as_directive = ["mermaid"]
+
+
 copybutton_prompt_text = ">>> "
 copybutton_only_copy_prompt_lines = False