Skip to content

Fix the table of samplers in the docs#6290

Merged
y0z merged 6 commits intooptuna:masterfrom
kAIto47802:doc-fix-sampler-table
Oct 10, 2025
Merged

Fix the table of samplers in the docs#6290
y0z merged 6 commits intooptuna:masterfrom
kAIto47802:doc-fix-sampler-table

Conversation

@kAIto47802
Copy link
Copy Markdown
Collaborator

Motivation

This PR is a follow-up PR for this PR:

Description of the changes

  • Add a link to AutoSampler and format it as a code block.
  • Fix the link of BoTorchSampler, since it is located in optuna_integration, not in optuna.
  • Remove the white spaces before and after the en dash (U+2013)as they should not be inserted according to several style guides, including Chicago Manual of Style 1, APA Style, IEEE Editorial Style Manual, Oxford Style Manual, New Oxford Style Manual.
  • (nit) Fixed the spacing around BruteForceSampler, which was slightly misaligned.

To add a link to the BoTorchSampler document in optuna_integration, I add optuna_integration in intersphinx_mapping in conf.py. Note that this approach cannot be used for AutoSampler, since its document is not based on sphinx.

Footnotes

  1. https://www.chicagomanualofstyle.org/qanda/data/faq/topics/HyphensEnDashesEmDashes/faq0108.html

@y0z y0z assigned y0z and sawa3030 Oct 2, 2025
@y0z
Copy link
Copy Markdown
Member

y0z commented Oct 2, 2025

@sawa3030, could you review this PR?

@y0z y0z added the document Documentation related. label Oct 2, 2025
@sawa3030
Copy link
Copy Markdown
Collaborator

sawa3030 commented Oct 3, 2025

I found that the text AutoSampler is displayed in red, even though the link functions correctly and redirects to the corresponding documentation. This behavior appears unintended and undesirable. Could you please update this?

image

@kAIto47802
Copy link
Copy Markdown
Collaborator Author

I’m aware that the text for AutoSampler is showing up in red. If you want to update it, could you please suggest a concrete solution?
As far as I know, the only way to make it exactly the same as the other samplers is to use custom CSS. As I mentioned above, AutoSampler cannot use cross-references, since its documentation is not based on Sphinx but on its own system.

cf. In the original state, it had no link at all and wasn’t even shown as inline code.

@kAIto47802
Copy link
Copy Markdown
Collaborator Author

I also made the following two update:

@codecov
Copy link
Copy Markdown

codecov bot commented Oct 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.10%. Comparing base (6624800) to head (e046e95).
⚠️ Report is 79 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6290      +/-   ##
==========================================
- Coverage   89.15%   89.10%   -0.05%     
==========================================
  Files         209      209              
  Lines       13908    13919      +11     
==========================================
+ Hits        12399    12402       +3     
- Misses       1509     1517       +8     

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

Co-authored-by: Yoshihiko Ozaki <30489874+y0z@users.noreply.github.com>
Copy link
Copy Markdown
Member

@y0z y0z left a comment

Choose a reason for hiding this comment

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

LGTM

@y0z y0z removed their assignment Oct 9, 2025
Copy link
Copy Markdown
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 very much for the inofrmation and the updates. LGTM

@y0z y0z merged commit 57eacd1 into optuna:master Oct 10, 2025
14 checks passed
@not522 not522 added this to the v4.6.0 milestone Oct 21, 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