Merge pull request #645 from not522/gpsampler-doc

Add `PreferentialGPSampler` document

docs/api.rst

@@ -44,6 +44,7 @@ Preferential Optimization
    optuna_dashboard.preferential.create_study
    optuna_dashboard.preferential.load_study
    optuna_dashboard.preferential.PreferentialStudy
+   optuna_dashboard.preferential.samplers.gp.PreferentialGPSampler
    optuna_dashboard.register_preference_feedback_component
 
 Streamlit

optuna_dashboard/preferential/samplers/gp.py

@@ -284,6 +284,26 @@ class _PreferentialGP:
 
 
 class PreferentialGPSampler(optuna.samplers.BaseSampler):
+    """Sampler for preferential optimization using Gaussian process.
+
+    The sampling algorithm is based on `Takeno et al., 2023 <https://arxiv.org/abs/2302.01513>`_.
+    This sampler uses BoTorch to optimize acquisition function.
+
+    Args:
+        kernel:
+            Kernel that computes the covariance on the Gaussian process. Defaults to
+            Matern 3/2 Kernel + ARD.
+        noise_prior:
+            Prior of the observation noise. Defaults to gamma prior.
+        independent_sampler:
+            A :class:`~optuna.samplers.BaseSampler` instance that is used for independent
+            sampling. The parameters not contained in the relative search space are sampled
+            by this sampler. If :obj:`None` is specified,
+            :class:`~optuna.samplers.RandomSampler` is used as the default.
+        seed:
+            Seed for random number generator.
+    """
+
     def __init__(
         self,
         *,

pyproject.toml

@@ -36,6 +36,7 @@ dynamic = ["version"]
 [project.optional-dependencies]
 docs = [
     "boto3",
+    "botorch",
     "streamlit",
     "sphinx",
     "sphinx_rtd_theme",