Add docs for acuisition functions

jungtaekkim · Nov 22, 2024 · 1aa7485 · 1aa7485
1 parent 5ba689a
commit 1aa7485
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 0 deletions.
diff --git a/docs/python_api/bayeso.acquisitions.augmented_expected_improvement.rst b/docs/python_api/bayeso.acquisitions.augmented_expected_improvement.rst
@@ -0,0 +1,8 @@
+bayeso.acquisitions.augmented\_expected\_improvement
+====================================================
+
+.. automodule:: bayeso.acquisitions.augmented_expected_improvement
+   :members:
+   :private-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/python_api/bayeso.acquisitions.expected_improvement.rst b/docs/python_api/bayeso.acquisitions.expected_improvement.rst
@@ -0,0 +1,8 @@
+bayeso.acquisitions.expected\_improvement
+=========================================
+
+.. automodule:: bayeso.acquisitions.expected_improvement
+   :members:
+   :private-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/python_api/bayeso.acquisitions.gaussian_process_upper_confidence_bound.rst b/docs/python_api/bayeso.acquisitions.gaussian_process_upper_confidence_bound.rst
@@ -0,0 +1,8 @@
+bayeso.acquisitions.gaussian\_process\_upper\_confidence\_bound
+===============================================================
+
+.. automodule:: bayeso.acquisitions.gaussian_process_upper_confidence_bound
+   :members:
+   :private-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/python_api/bayeso.acquisitions.probability_of_improvement.rst b/docs/python_api/bayeso.acquisitions.probability_of_improvement.rst
@@ -0,0 +1,8 @@
+bayeso.acquisitions.probability\_of\_improvement
+================================================
+
+.. automodule:: bayeso.acquisitions.probability_of_improvement
+   :members:
+   :private-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/python_api/bayeso.acquisitions.pure_exploitation.rst b/docs/python_api/bayeso.acquisitions.pure_exploitation.rst
@@ -0,0 +1,8 @@
+bayeso.acquisitions.pure\_exploitation
+======================================
+
+.. automodule:: bayeso.acquisitions.pure_exploitation
+   :members:
+   :private-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/python_api/bayeso.acquisitions.pure_exploration.rst b/docs/python_api/bayeso.acquisitions.pure_exploration.rst
@@ -0,0 +1,8 @@
+bayeso.acquisitions.pure\_exploration
+=====================================
+
+.. automodule:: bayeso.acquisitions.pure_exploration
+   :members:
+   :private-members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/python_api/bayeso.acquisitions.rst b/docs/python_api/bayeso.acquisitions.rst
@@ -0,0 +1,17 @@
+bayeso.acquisitions
+===================
+
+.. automodule:: bayeso.wrappers
+   :members:
+   :private-members:
+   :undoc-members:
+   :show-inheritance:
+
+.. toctree::
+
+   bayeso.acquisitions.probability_of_improvement
+   bayeso.acquisitions.expected_improvement
+   bayeso.acquisitions.gaussian_process_upper_confidence_bound
+   bayeso.acquisitions.augmented_expected_improvement
+   bayeso.acquisitions.pure_exploitation
+   bayeso.acquisitions.pure_exploration