DOC added reference to plot_grid_search_stats.py #30965
Conversation
There was a problem hiding this comment.
Hello @Cheath2,
thanks for making this PR.
To be honest, I believe this link would be misplaced in the Halving*Search section. This section and the example both deal with cv_results_, but the section where you linked it focuses on explaining the structure of the results in Halving, while the example you linked is more about visualizing and interpreting GridSearchCV results graphically.
Also, the example is already linked above in the GridSearch section (line 106), where it seems better placed.
Since the example shows how to plot and interpret results using GridSearch's cv_results_ attribute, I would rather suggest to add it to the docstring of GridSearchCV in the attribute description of cv_results_.
Also probably change the description from "in-depth statistical analysis" to "visualization and interpretation of GridSearch results" or something similar.
Would you be up to do that? If so, you would also need to remove the desktop.ini file from your PR and only push the actual change. Thank you.
|
Hello @StefanieSenger , Thank you for your guidance, I believe I have updated the PR per your instruction. I updated the verbiage, moved the example reference to the attribute description within cv_results_ docstring under the existing reference text, and addressed the .ini issue. Please let me know if any other changes are needed. |
There was a problem hiding this comment.
Thank you @Cheath2, that looks very good.
Can we merge this, @adrinjalali?
|
Can you please add a DOC in from of your PR title, @Cheath2? |
| For an example of visualization and interpretation of GridSearch results, | ||
| see :ref:`sphx_glr_auto_examples_model_selection_plot_grid_search_stats.py`. |
There was a problem hiding this comment.
I like where this link is, but it could be also added to all the other 3 search cv classes where cv_results_ are present.
Reference Issues/PRs
Towards #30621
What does this implement/fix? Explain your changes.
Added a reference to plot_grid_search_stats.py within the User manuals 'Analyzing results with the
cv_results_attribute' section.Any other comments?