Merge pull request #77 from y0z/feature/cma

Migrate pycma integration
optuna · Feb 9, 2024 · 765ba16 · 765ba16
2 parents 8c6eb13 + 20d7661
commit 765ba16
Show file tree

Hide file tree

Showing 8 changed files with 917 additions and 3 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -49,11 +49,14 @@ jobs:
         pip install --progress-bar off .[test]
         pip install --progress-bar off .[all]
 
+        # Install optuna from optuna master
+        pip install git+https://github.com/optuna/optuna@master
+
         # Install distributed to run importance_tests/test_init tests.
         pip install distributed
 
         echo 'import coverage; coverage.process_startup()' > sitecustomize.py
-    
+
     - name: Output installed packages
       run: |
         pip freeze --all

diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ Optuna-Integration API reference is [here](https://optuna-integration.readthedoc
 * FastAI ([V1](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#fastaiv1)  ([example](https://github.com/optuna/optuna-examples/tree/main/fastai/fastaiv1_simple.py)), ([V2](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#fastaiv2)  ([example]https://github.com/optuna/optuna-examples/tree/main/fastai/fastaiv2_simple.py)))
 * [Keras](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#keras)  ([example](https://github.com/optuna/optuna-examples/tree/main/keras))
 * [MXNet](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#mxnet)  ([example](https://github.com/optuna/optuna-examples/tree/main/mxnet))
+* [pycma](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#pycma)
 * [scikit-optimize](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#skopt)
 * [SHAP](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#shap)
 * [sklearn](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#sklearn)  ([example](https://github.com/optuna/optuna-examples/tree/main/sklearn/sklearn_optuna_search_cv_simple.py))

diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst
@@ -109,6 +109,15 @@ MXNet
 
    optuna_integration.MXNetPruningCallback
 
+pycma
+-----
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   optuna_integration.CmaEsSampler
+   optuna_integration.PyCmaSampler
+
 scikit-optimize
 ---------------
 

diff --git a/optuna_integration/__init__.py b/optuna_integration/__init__.py
@@ -12,6 +12,7 @@
     "catboost": ["CatBoostPruningCallback"],
     "chainer": ["ChainerPruningExtension"],
     "chainermn": ["ChainerMNStudy"],
+    "cma": ["CmaEsSampler", "PyCmaSampler"],
     "dask": ["DaskStorage"],
     "fastaiv1": ["FastAIV1PruningCallback"],
     "fastaiv2": ["FastAIV2PruningCallback", "FastAIPruningCallback"],
@@ -36,6 +37,8 @@
     from optuna_integration.catboost import CatBoostPruningCallback
     from optuna_integration.chainer import ChainerPruningExtension
     from optuna_integration.chainermn import ChainerMNStudy
+    from optuna_integration.cma import CmaEsSampler
+    from optuna_integration.cma import PyCmaSampler
     from optuna_integration.dask import DaskStorage
     from optuna_integration.fastaiv1 import FastAIV1PruningCallback
     from optuna_integration.fastaiv2 import FastAIPruningCallback
@@ -112,6 +115,8 @@ def _get_module(self, module_name: str) -> ModuleType:
     "KerasPruningCallback",
     "MXNetPruningCallback",
     "OptunaSearchCV",
+    "CmaEsSampler",
+    "PyCmaSampler",
     "ShapleyImportanceEvaluator",
     "SkoptSampler",
     "SkorchPruningCallback",