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 new section explaing how to customize figures #5194

Merged
merged 4 commits into from Feb 13, 2024

Conversation

nzw0301
Copy link
Member

@nzw0301 nzw0301 commented Jan 21, 2024

Motivation

Resolve #5178

Description of the changes

Add a new section to clarify the methods that return editable objects and a simple example to replace titles of plot_intermediate_values.

@nzw0301 nzw0301 added the document Documentation related. label Jan 21, 2024
Copy link

codecov bot commented Jan 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (308a645) 89.40% compared to head (da447bd) 89.36%.
Report is 29 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5194      +/-   ##
==========================================
- Coverage   89.40%   89.36%   -0.05%     
==========================================
  Files         206      206              
  Lines       15126    15097      -29     
==========================================
- Hits        13524    13492      -32     
- Misses       1602     1605       +3     

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

@nzw0301
Copy link
Member Author

nzw0301 commented Jan 21, 2024

@HideakiImamura
Copy link
Member

How about adding the link to the document of Plotly?

https://plotly.com/python-api-reference/generated/plotly.graph_objects.Figure.html

In addition, I think it would be great to add an example for Matplotlib. Could you add that?

@HideakiImamura HideakiImamura self-assigned this Jan 22, 2024
@nzw0301
Copy link
Member Author

nzw0301 commented Jan 22, 2024

Thank you for your feedback. Sure I'll update this PR in a few days.

Copy link
Contributor

This pull request has not seen any recent activity.

@github-actions github-actions bot added stale Exempt from stale bot labeling. and removed stale Exempt from stale bot labeling. labels Jan 29, 2024
@HideakiImamura
Copy link
Member

Hi @nzw0301. Is this PR ready for review?

@nzw0301
Copy link
Member Author

nzw0301 commented Feb 2, 2024

@HideakiImamura Yes! 19121aa includes your suggestion.

@nzw0301
Copy link
Member Author

nzw0301 commented Feb 2, 2024

Sorry, I realised that plotly's link is broken, concretely, the generated link is https://plotly.com/python-api-reference/generated/plotly.graph_objs.Figure.html#id0 which is not found. Note that this broken link problem also happens in pages of optuna.visualization. I'll fix the link for this tutorial.

@nzw0301

This comment was marked as resolved.

Copy link
Member

@HideakiImamura HideakiImamura left a comment

Choose a reason for hiding this comment

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

LGTM.

@HideakiImamura HideakiImamura merged commit 0b7be82 into optuna:master Feb 13, 2024
22 checks passed
@HideakiImamura HideakiImamura added this to the v3.6.0 milestone Feb 13, 2024
@nzw0301 nzw0301 deleted the clarify-how-to-edit-figs branch February 13, 2024 05:54
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.

Add documentation for customizing visualization function output
2 participants