DOC Add dropdowns to User Guide section 3.2, "Tuning the hyper-parameters of an estimator" by jeromedockes · Pull Request #27631 · scikit-learn/scikit-learn

jeromedockes · 2023-10-20T15:10:19Z

Reference Issues/PRs

closes #26617

What does this implement/fix? Explain your changes.

as described in #26617, shorten this section of the user guide by folding some parts in <details>

Any other comments?

…rch-user-guide

github-actions · 2023-10-20T15:11:52Z

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

_{Generated for commit: 45aa61a. Link to the linter CI: here}

jeromedockes · 2023-10-20T15:11:58Z

doc/modules/grid_search.rst

-      amount of flexibility in identifying the "best" estimator. This interface
-      can also be used in multiple metrics evaluation.
+    - See
+      :ref:`sphx_glr_auto_examples_model_selection_plot_grid_search_refit_callable.py`


those 2 examples seem to showcase very similar functionality

jeromedockes · 2023-10-20T15:13:04Z

doc/modules/grid_search.rst

-(or `=np.nan`) will make the procedure robust to such failure, issuing a
-warning and setting the score for that fold to 0 (or `nan`), but completing
-the search.
+Some parameter settings may result in a failure to ``fit`` one or more folds of


This is not related to dropdowns but that part appears to be outdated as error_score=np.nan is now the default; LMK if it should be handled in another issue & pr instead

Nice catch! I think it's ok to address the issue here.

…rch-user-guide

ArturoAmorQ

Thanks for your time and work @jeromedockes, I like your approach for using dropdowns. The only issue here is that they break the sphinx references (such as .. _amount_of_resource_and_number_of_candidates: in line 295). One can still use permalinks as introduced in #27409, but then we rather hide one subsection of 3.2.3 Searching for optimal parameters with successive halving at the time, or WDYT?

ArturoAmorQ · 2023-11-24T14:51:09Z

doc/modules/grid_search.rst

-(or `=np.nan`) will make the procedure robust to such failure, issuing a
-warning and setting the score for that fold to 0 (or `nan`), but completing
-the search.
+Some parameter settings may result in a failure to ``fit`` one or more folds of


Nice catch! I think it's ok to address the issue here.

…rch-user-guide

jeromedockes · 2023-11-30T17:47:59Z

The only issue here is that they break the sphinx references

Sorry I missed that!
I think I did not realize because they work when the <details> is expanded, and AFAICT all the references are in the same section so to see/click the links that stop working when we collapse the section we have to expand it

One can still use permalinks as introduced in #27409, but then we rather hide one subsection of 3.2.3 Searching for optimal parameters with successive halving at the time, or WDYT?

That sounds better. It might be a bit awkward to have 6 collapsed sections in a row, but better than breaking the references.
As there is so much information about successive halving and these sections have 3 levels of nesting (3.2.3.1-6), we could also consider having a dedicated page just for successive halving?

jeromedockes · 2023-11-30T18:09:08Z

One can still use permalinks as introduced in #27409, but then we rather hide one subsection of 3.2.3 Searching for optimal parameters with successive halving at the time, or WDYT?

AFAICT the ids added in #27409 are added with javascript when the page is rendered. if we use those anchors does that mean I should replace sphinx references with hyperlinks? one drawback is I guess those will not be checked by sphinx

note here the situation is a bit different than #27408 because when the anchor is also inside the <details>, sphinx does create the reference -- but following the link does not automatically expand the section

ArturoAmorQ · 2024-01-22T11:16:58Z

That sounds better. It might be a bit awkward to have 6 collapsed sections in a row, but better than breaking the references.

I don't think it is that awkward, we have 3 collapsed sections in a row in the Contributing Guide. If you find it pertinent, maybe we can keep a short intro to each subsection before hiding the rest in a dropdown. This would solve the problem with the hyperlinks.

ArturoAmorQ · 2024-02-27T15:42:33Z

👀

…rch-user-guide

ArturoAmorQ

Thanks for reviving this PR! Just a couple of comments :)

ArturoAmorQ · 2024-03-13T16:48:38Z

doc/modules/grid_search.rst

 :ref:`exhausting_the_resources` for details.
+|details-end|

 .. _amount_of_resource_and_number_of_candidates:


We will have to use a permalink to replace this cross-reference. Happily it is only referenced from this rst file.

doc/modules/grid_search.rst

ArturoAmorQ · 2024-03-13T16:51:57Z

doc/modules/grid_search.rst

 .. _amount_of_resource_and_number_of_candidates:

+|details-start|
 Amount of resource and number of candidates at each iteration


Maybe just a nit, but we can try to use bold titles for the dropdowns.

glemaitre · 2024-05-17T07:18:24Z

@jeromedockes Could you finish this PR. This is actually the last one from the meta issue and then we can close ;)

jeromedockes · 2024-05-17T08:01:51Z

Sorry about that! I'll finish it on Wednesday at the latest.

glemaitre · 2024-05-17T08:33:14Z

Sorry about that! I'll finish it on Wednesday at the latest.

No worries, I was just doing some book keeping and just saw that it was the last issue. Take your time to solve this PR, there is no rush.

…rch-user-guide

ArturoAmorQ

I hope after these comments are addressed, this PR should be good to go.

doc/modules/grid_search.rst

ArturoAmorQ

LGTM. Let's merge and iterate over time if needed. Thanks @jeromedockes!

…ters of an estimator" (scikit-learn#27631)

…ters of an estimator" (#27631)

start introducing details sections in grid_search.rst

1e1ec32

jeromedockes changed the title ~~Add dropdowns to User Guide section 3.2, "Tuning the hyper-parameters of an estimator"~~ [WIP] Add dropdowns to User Guide section 3.2, "Tuning the hyper-parameters of an estimator" Oct 20, 2023

jeromedockes marked this pull request as draft October 20, 2023 15:10

Merge remote-tracking branch 'upstream/main' into dropdown-in-gridsea…

b93c32b

…rch-user-guide

jeromedockes commented Oct 20, 2023

View reviewed changes

jeromedockes mentioned this pull request Oct 20, 2023

DOC Introduce dropdowns in the User Guide #26617

Closed

54 tasks

jeromedockes changed the title ~~[WIP] Add dropdowns to User Guide section 3.2, "Tuning the hyper-parameters of an estimator"~~ [WIP] DOC Add dropdowns to User Guide section 3.2, "Tuning the hyper-parameters of an estimator" Oct 20, 2023

github-actions bot added the Documentation label Oct 20, 2023

Merge remote-tracking branch 'upstream/main' into dropdown-in-gridsea…

fa85109

…rch-user-guide

jeromedockes marked this pull request as ready for review October 31, 2023 08:14

jeromedockes changed the title ~~[WIP] DOC Add dropdowns to User Guide section 3.2, "Tuning the hyper-parameters of an estimator"~~ DOC Add dropdowns to User Guide section 3.2, "Tuning the hyper-parameters of an estimator" Oct 31, 2023

ArturoAmorQ reviewed Nov 24, 2023

View reviewed changes

Merge remote-tracking branch 'upstream/main' into dropdown-in-gridsea…

08b68f8

…rch-user-guide

jeromedockes added 2 commits March 6, 2024 11:39

Merge remote-tracking branch 'upstream/main' into dropdown-in-gridsea…

0e5cbf4

…rch-user-guide

section titles out of dropdown

53310b4

ArturoAmorQ reviewed Mar 13, 2024

View reviewed changes

jeromedockes added 4 commits June 26, 2024 11:18

Merge remote-tracking branch 'upstream/main' into dropdown-in-gridsea…

32b1078

…rch-user-guide

broken link

9a945e3

_

731ed5a

broken link

e9719f9

ArturoAmorQ reviewed Jul 11, 2024

View reviewed changes

Apply suggestions from code review

4fd7a38

Merge branch 'main' into dropdown-in-gridsearch-user-guide

45aa61a

ArturoAmorQ approved these changes Sep 5, 2024

View reviewed changes

ArturoAmorQ merged commit 390ce98 into scikit-learn:main Sep 5, 2024

glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Sep 9, 2024

DOC Add dropdowns to User Guide section 3.2, "Tuning the hyper-parame…

6960e45

…ters of an estimator" (scikit-learn#27631)

glemaitre pushed a commit that referenced this pull request Sep 11, 2024

DOC Add dropdowns to User Guide section 3.2, "Tuning the hyper-parame…

7b7f1e6

…ters of an estimator" (#27631)

Uh oh!

Conversation

jeromedockes commented Oct 20, 2023 • edited by glemaitre Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

Uh oh!

github-actions bot commented Oct 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✔️ Linting Passed

Uh oh!

jeromedockes Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

jeromedockes Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

ArturoAmorQ Nov 24, 2023

Choose a reason for hiding this comment

Uh oh!

ArturoAmorQ left a comment

Choose a reason for hiding this comment

Uh oh!

ArturoAmorQ Nov 24, 2023

Choose a reason for hiding this comment

Uh oh!

jeromedockes commented Nov 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeromedockes commented Nov 30, 2023

Uh oh!

ArturoAmorQ commented Jan 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ArturoAmorQ commented Feb 27, 2024

Uh oh!

ArturoAmorQ left a comment

Choose a reason for hiding this comment

Uh oh!

ArturoAmorQ Mar 13, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ArturoAmorQ Mar 13, 2024

Choose a reason for hiding this comment

Uh oh!

glemaitre commented May 17, 2024

Uh oh!

jeromedockes commented May 17, 2024 via email

Uh oh!

glemaitre commented May 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ArturoAmorQ left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ArturoAmorQ left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jeromedockes commented Oct 20, 2023 •

edited by glemaitre

Loading

github-actions bot commented Oct 20, 2023 •

edited

Loading

jeromedockes commented Nov 30, 2023 •

edited

Loading

ArturoAmorQ commented Jan 22, 2024 •

edited

Loading

glemaitre commented May 17, 2024 •

edited

Loading

ArturoAmorQ left a comment •

edited

Loading