wassname/optuna-dashboard
1
0
Fork 0
mirror of https://github.com/wassname/optuna-dashboard.git synced 2026-09-09 11:28:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #646 from contramundum53/experimental-warning-doc

Browse Source 
Add experimental warnings on doc
This commit is contained in:
Naoto Mizuno
2023-10-05 17:50:27 +09:00
committed by GitHub
parent a1bb12d4bc b8ef10d1f1
commit 0e5398c11e
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
optuna_dashboard/preferential/_study.py
+12
View File
@@ -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 v0.13.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 v0.13.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 v0.13.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()