Skip to content

Update example in index.rst to AutoSampler #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Update example in index.rst to AutoSampler #70

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42f633b
Update example to AutoSampler
kAIto47802 Nov 8, 2024
f305934
Fix indent
kAIto47802 Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Install the `optunahub`_ package.
pip install optunahub
Load the package you want from the OptunaHub registry. In the next example code, you will load the ``SimulatedAnnealingSampler`` from the `samplers/simulated_annealing <https://hub.optuna.org/samplers/simulated_annealing/>`__ package.
Load the package you want from the OptunaHub registry. In the next example code, you will load the ``AutoSampler`` from the `samplers/auto_sampler <https://hub.optuna.org/samplers/auto_sampler/>`__ package.
The details for ``AutoSampler`` can be found in `this article <https://medium.com/optuna/autosampler-automatic-selection-of-optimization-algorithms-in-optuna-1443875fd8f9>`__.

.. code-block:: python
Expand All @@ -24,15 +25,16 @@ Load the package you want from the OptunaHub registry. In the next example code,
def objective(trial: optuna.Trial) -> float:
x = trial.suggest_float("x", 0, 1)
x = trial.suggest_float("x", -5, 5)
y = trial.suggest_float("y", -5, 5)
return x
return x**2 + y**2
mod = optunahub.load_module("samplers/simulated_annealing")
mod = optunahub.load_module("samplers/auto_sampler")
study = optuna.create_study(sampler=mod.SimulatedAnnealingSampler())
study.optimize(objective, n_trials=20)
study = optuna.create_study(sampler=mod.AutoSampler())
study.optimize(objective, n_trials=10)
print(study.best_trial.value, study.best_trial.params)
Expand Down
Loading