Skip to content

Improve parallelization document #6123

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

Merged
merged 12 commits into from
Jun 13, 2025

Conversation

gen740
Copy link
Member

@gen740 gen740 commented Jun 3, 2025

Motivation

The Easy Parallelization section of the Optuna documentation is somewhat outdated.

To improve its clarity and usefulness, I have updated the content by adding additional descriptions and illustrative diagrams.
These changes aim to better reflect current best practices for multi-threaded, multi-process, and multi-node optimization in Optuna.

Description of the changes

  • Update the document contents to explain each parallelization technique.
  • Add diagrams to help users select the best optimization strategy.

Copy link

codecov bot commented Jun 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.39%. Comparing base (2832e92) to head (440d03a).
Report is 107 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6123      +/-   ##
==========================================
+ Coverage   88.34%   88.39%   +0.05%     
==========================================
  Files         207      207              
  Lines       13975    14036      +61     
==========================================
+ Hits        12346    12407      +61     
  Misses       1629     1629              

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

@gen740 gen740 changed the title Improve parallelizing document Improve parallelization document Jun 3, 2025
@HideakiImamura HideakiImamura self-assigned this Jun 3, 2025
@y0z y0z added the document Documentation related. label Jun 4, 2025
@y0z y0z self-assigned this Jun 4, 2025
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.

Thanks for the PR! Basically, LGTM. I have several comments, PTAL.

@gen740 gen740 force-pushed the fix-parallelizing-document branch from e27dac7 to 8267f90 Compare June 6, 2025 04:04
Co-authored-by: Hideaki Imamura <[email protected]>

Update tutorial/10_key_features/004_distributed.py

Co-authored-by: Hideaki Imamura <[email protected]>

Update tutorial/10_key_features/004_distributed.py

Co-authored-by: Hideaki Imamura <[email protected]>

Apply suggestions from code review

Co-authored-by: Hideaki Imamura <[email protected]>

Update tutorial/10_key_features/004_distributed.py

Co-authored-by: Hideaki Imamura <[email protected]>
@gen740 gen740 force-pushed the fix-parallelizing-document branch from 79cba7f to 2e9cff4 Compare June 6, 2025 04:10
@gen740 gen740 force-pushed the fix-parallelizing-document branch from ec5f0fc to a4b0861 Compare June 6, 2025 06:31
@HideakiImamura HideakiImamura assigned sawa3030 and unassigned y0z Jun 6, 2025
@HideakiImamura
Copy link
Member

@sawa3030 Could you review this PR?

@gen740 gen740 force-pushed the fix-parallelizing-document branch from b5a882a to a0defcb Compare June 6, 2025 09:34
@gen740 gen740 force-pushed the fix-parallelizing-document branch from a0defcb to 64a7b94 Compare June 6, 2025 12:22
Copy link
Collaborator

@sawa3030 sawa3030 left a comment

Choose a reason for hiding this comment

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

Apologies for the delay, and thank you for your patience. I found the document very helpful and easy to follow, even as a beginner in parallelization. I've added a few minor comments. PTAL.

@gen740
Copy link
Member Author

gen740 commented Jun 13, 2025

@sawa3030
Thank you for your review. I applied the review comment. PTAL.


.. _multi-thread-optimization:

Multi-thread Optimization
Copy link
Collaborator

Choose a reason for hiding this comment

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

The current titles seem to follow this pattern:

  • Multi-thread Optimization
  • Multi-process Optimization with JournalStorage
  • Multi-node Optimization
  • GRPC Proxy Storage

To make them more consistent, how about updating them to:

  • Multi-thread Optimization
  • Multi-process Optimization with JournalStorage
  • Multi-node Optimization with RDBStorage
  • Multi-node Optimization with GrpcStorageProxy

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!

Copy link
Collaborator

@sawa3030 sawa3030 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 updates. LGTM

@HideakiImamura HideakiImamura merged commit 639d525 into optuna:master Jun 13, 2025
14 checks passed
@HideakiImamura HideakiImamura added this to the v4.5.0 milestone Jun 13, 2025
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.

4 participants