Skip to content
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.

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

Add a tutorial demonstrating how to display plots in Optuna-Dashboard #81

Merged
merged 3 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion docs/source/index.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add a line saying that we have tutorials both for OptunaHub and OptunaHub Registry?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only added tutorial for OptunaHub because tutorial of OptunaHub-Registry is already mentioned.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ Welcome to OptunaHub's documentation!

`OptunaHub <https://hub.optuna.org/>`__ is a registry of third-party packages designed for `Optuna <https://optuna.org>`__.
It allows users to share and discover Optuna packages that are not included in the official Optuna distribution.
The `optunahub <https://github.com/optuna/optunahub/>`_ library provides Python APIs to load and use packages from the OptunaHub registry.
The `optunahub <https://github.com/optuna/optunahub/>`__ library provides Python APIs to load and use packages from the OptunaHub registry.
Please check out `the OptunaHub tutorial <./tutorials/index.html>`__ as well.

**If you are interested in registering your own features in OptunaHub**, please visit `the optunahub-registry repository <https://github.com/optuna/optunahub-registry>`__ and submit a pull request there. More details are available in `the optunahub-registry tutorial <https://optuna.github.io/optunahub-registry/>`__.

Expand Down Expand Up @@ -49,4 +50,5 @@ Get ready to explore the most suitable packages for your problems in the `Optuna
:caption: Contents:

reference
tutorials/index
faq
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/source/tutorials/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Tutorials
=========

.. toctree::
:maxdepth: 1

plot-in-optuna-dashboard
72 changes: 72 additions & 0 deletions docs/source/tutorials/plot-in-optuna-dashboard.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Tutorial: How to Plot in Optuna-Dashboard
=========================================

In this tutorial, we will explain how to display plots in `Optuna-Dashboard <https://optuna-dashboard.readthedocs.io/en/latest/index.html>`_.

`optuna_dashboard.save_plotly_graph_object <https://optuna-dashboard.readthedocs.io/en/latest/_generated/optuna_dashboard.save_plotly_graph_object.html#optuna_dashboard.save_plotly_graph_object>`__ can be used
to integrate and display plots generated by Optunahub modules in Optuna-Dashboard.


Preparation
-----------

First, ensure the necessary packages are installed by executing the following command:

.. code-block:: console

$ pip install optuna optunahub optuna-dashboard

Example
-------

To illustrate an example, we use `The WFG Problem Collection <https://hub.optuna.org/benchmarks/wfg/>`__ and `Plot Pareto Front for Multiple Studies <https://hub.optuna.org/visualization/plot_pareto_front_multi/>`__.


.. code-block:: python

import optuna
import optunahub
from optuna_dashboard import save_plotly_graph_object

wfg = optunahub.load_module("benchmarks/wfg")
wfg4 = wfg.Problem(function_id=4, n_objectives=2, dimension=3, k=1)

samplers = [
optuna.samplers.RandomSampler(),
optuna.samplers.TPESampler(),
optuna.samplers.NSGAIISampler(),
]
studies = []

for sampler in samplers:
study = optuna.create_study(
sampler=sampler,
study_name=sampler.__class__.__name__,
directions=wfg4.directions,
storage="sqlite:///db.sqlite3",
)
study.optimize(wfg4, n_trials=100)
studies.append(study)

m = optunahub.load_module(
"visualization/plot_pareto_front_multi"
)
fig = m.plot_pareto_front(studies)

for study in studies:
save_plotly_graph_object(study, fig)

After running this code, launch the Optuna-Dashboard by the following command:

.. code-block:: console

$ optuna-dashboard sqlite:///db.sqlite3

Then, go to one of the study pages.
You can see the plot in the dashboard like the image below.

.. figure:: ./images/plot-in-optuna-dashboard.png
:alt: Plot in Optuna-Dashboard
:align: center
:width: 800px

Loading