Merge pull request #72 from y0z/feature/botorch

Migrate BoTorch integration
optuna · Feb 7, 2024 · 2fd5266 · 2fd5266
2 parents 2734577 + b185aa4
commit 2fd5266
Show file tree

Hide file tree

Showing 7 changed files with 2,363 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ integrated with many useful tools like PyTorch, sklearn, TensorFlow, etc.
 Optuna-Integration API reference is [here](https://optuna-integration.readthedocs.io/en/stable/reference/index.html).
 
 * [AllenNLP](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#allennlp)  ([example](https://github.com/optuna/optuna-examples/tree/main/allennlp))
+* [BoTorch](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#botorch)
 * [Catalyst](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#catalyst)  ([example](https://github.com/optuna/optuna-examples/blob/main/pytorch/catalyst_simple.py))
 * [CatBoost](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#catboost)  ([example](https://github.com/optuna/optuna-examples/blob/main/catboost/catboost_pruning.py))
 * [Chainer](https://optuna-integration.readthedocs.io/en/stable/reference/index.html#chainer)  ([example](https://github.com/optuna/optuna-examples/tree/main/chainer/chainer_integration.py))

diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst
@@ -27,6 +27,22 @@ AllenNLP
    optuna_integration.allennlp.dump_best_config
    optuna_integration.AllenNLPPruningCallback
 
+BoTorch
+-------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   optuna_integration.BoTorchSampler
+   optuna_integration.botorch.ehvi_candidates_func
+   optuna_integration.botorch.logei_candidates_func
+   optuna_integration.botorch.qei_candidates_func
+   optuna_integration.botorch.qnei_candidates_func
+   optuna_integration.botorch.qehvi_candidates_func
+   optuna_integration.botorch.qnehvi_candidates_func
+   optuna_integration.botorch.qparego_candidates_func
+
 Catalyst
 --------
 

diff --git a/optuna_integration/__init__.py b/optuna_integration/__init__.py
@@ -7,6 +7,7 @@
 
 _import_structure = {
     "allennlp": ["AllenNLPExecutor", "AllenNLPPruningCallback"],
+    "botorch": ["BoTorchSampler"],
     "catalyst": ["CatalystPruningCallback"],
     "catboost": ["CatBoostPruningCallback"],
     "chainer": ["ChainerPruningExtension"],
@@ -27,6 +28,7 @@
 if TYPE_CHECKING:
     from optuna_integration.allennlp import AllenNLPExecutor
     from optuna_integration.allennlp import AllenNLPPruningCallback
+    from optuna_integration.botorch import BoTorchSampler
     from optuna_integration.catalyst import CatalystPruningCallback
     from optuna_integration.catboost import CatBoostPruningCallback
     from optuna_integration.chainer import ChainerPruningExtension
@@ -92,6 +94,7 @@ def _get_module(self, module_name: str) -> ModuleType:
 __all__ = [
     "AllenNLPExecutor",
     "AllenNLPPruningCallback",
+    "BoTorchSampler",
     "CatalystPruningCallback",
     "CatBoostPruningCallback",
     "ChainerMNStudy",