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

Conversation

fusawa-yugo
Copy link

Motivation

I think integrating plots in optuna-dashboard is useful, so I added a tutorial how to do it/

Description of the changes

I created a simple tutorial, demonstrating how to use optuna_dashboard.save_plotly_graph_object with the example using Plot Pareto Front for Multiple Studies
I selected it as an example because it is simple and not a built-in module.

The output images are below.
スクリーンショット 2025-01-21 13 12 24
スクリーンショット 2025-01-21 13 12 35

@c-bata
Copy link
Member

c-bata commented Jan 21, 2025

@y0z Could you review this PR?

docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
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.

docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
docs/source/tutorials/plot-in-optuna-dashboard.rst Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.75%. Comparing base (61d47cc) to head (893452a).
Report is 10 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #81   +/-   ##
=======================================
  Coverage   88.75%   88.75%           
=======================================
  Files           9        9           
  Lines         169      169           
=======================================
  Hits          150      150           
  Misses         19       19           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fusawa-yugo
Copy link
Author

fusawa-yugo commented Jan 21, 2025

@nabenabe0928
Thank you for your feedbacks!!
Could you check it again?

Copy link
Contributor

@nabenabe0928 nabenabe0928 left a comment

Choose a reason for hiding this comment

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

Thank you for the update!
I added some minor comments:)

docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
@y0z y0z assigned nabenabe0928 and unassigned y0z Jan 23, 2025
@y0z y0z added the document Documentation related. label Jan 23, 2025
@y0z y0z added this to the v0.3.0 milestone Jan 23, 2025
@fusawa-yugo
Copy link
Author

fusawa-yugo commented Jan 24, 2025

Thank you again for feedbacks!!
I updated the content.

Copy link
Contributor

@nabenabe0928 nabenabe0928 left a comment

Choose a reason for hiding this comment

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

LGTM;!

@nabenabe0928 nabenabe0928 merged commit 26fae96 into optuna:main Jan 24, 2025
11 checks passed
@fusawa-yugo fusawa-yugo deleted the fusawa-yugo/add-tutorial-doc branch January 24, 2025 04:22
@fusawa-yugo fusawa-yugo restored the fusawa-yugo/add-tutorial-doc branch January 24, 2025 04:22
@fusawa-yugo fusawa-yugo deleted the fusawa-yugo/add-tutorial-doc branch January 24, 2025 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation related.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants