From d79f6b6c6f01364c3d0f3ca580df2a9655ae7a1c Mon Sep 17 00:00:00 2001 From: Contramundum Date: Thu, 5 Oct 2023 16:25:40 +0900 Subject: [PATCH] Add experimental warnings on doc --- optuna_dashboard/preferential/_study.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/optuna_dashboard/preferential/_study.py b/optuna_dashboard/preferential/_study.py index 6e093683..651dac98 100644 --- a/optuna_dashboard/preferential/_study.py +++ b/optuna_dashboard/preferential/_study.py @@ -37,6 +37,10 @@ class PreferentialStudy: To create and load a study, please refer to the documentation of :func:`~optuna_dashboard.preferential.create_study` and :func:`~optuna_dashboard.preferential.load_study` respectively. + + .. note:: + Preferential optimization is an experimental feature (introduced in v3.4.0). + The interface may change in newer versions without prior notice. """ def __init__(self, study: optuna.Study) -> None: @@ -359,6 +363,10 @@ def create_study( Returns: A :class:`~optuna_dashboard.preferential.PreferentialStudy` object. + + .. note:: + Preferential optimization is an experimental feature (introduced in v3.4.0). + The interface may change in newer versions without prior notice. """ try: study = optuna.create_study( @@ -441,6 +449,10 @@ def load_study( Returns: A :class:`~optuna_dashboard.preferential.PreferentialStudy` object. + + .. note:: + Preferential optimization is an experimental feature (introduced in v3.4.0). + The interface may change in newer versions without prior notice. """ study = optuna.load_study( study_name=study_name, storage=storage, sampler=sampler or RandomSampler()