DOC Add dropdowns in Module 3.3 #28355
Conversation
There was a problem hiding this comment.
Thanks for the PR @manuel-morales-a! Now that you're working on this section, can you also please hide
- the
One-vs-one AlgorithmandOne-vs-rest Algorithmof the Multi-class case subsection in 3.3.2.15. (in separate dropdowns) - the
Interpretation across varying prevalenceandMathematical divergencesin 3.3.2.19. Class likelihood ratios (also in separate dropdowns) - the subsections of 3.3.4.11. D² score (one dropdown per deviance)
doc/modules/model_evaluation.rst
Outdated
| |details-start| | ||
| **Square root of the MSE** | ||
| |details-split| | ||
|
|
||
| Taking the square root of the MSE, called the root mean squared error (RMSE), is another | ||
| common metric that provides a measure in the same units as the target variable. RSME is | ||
| available through the :func:`root_mean_squared_error` function. | ||
|
|
||
| |details-end| | ||
|
|
There was a problem hiding this comment.
This paragraph is short enough not to be hidden in a dropdown. It is also a common use metric, so we rather keep it visible.
There was a problem hiding this comment.
Very good! It has been de-dropdowned in one of the following commits.
|
Thanks for the feedback @ArturoAmorQ! I've implemented your comments. I have one remaining question. In 3.3.2.19. Class likelihood ratios, with the dropdowns I've implemented, the Thank you! |
I would rather move it above the |
|
Thank you! It should be good to go now: moved the examples as discussed. Cheers |
doc/modules/model_evaluation.rst
Outdated
| |details-start| | ||
| **References** | ||
| |details-split| |
There was a problem hiding this comment.
Sorry just a last comment, I just noticed some of the references (those with the format [authorDATE]) are called in some other parts of this page, but as of today, dropdowns break the sphynx cross-referencing system. Can you please revert the reference back to a topic directive whenever at least one of the references are called elsewhere?
There was a problem hiding this comment.
No problem! I've reinstated the topic directives when needed in the commit below. I had to remove a couple of dropdowns but most remained
doc/modules/model_evaluation.rst
Outdated
| |details-start| | ||
| **One-vs-rest Algorithm** | ||
| |details-split| | ||
| .. topic:: One-vs-rest Algorithm: |
There was a problem hiding this comment.
I am so sorry! I may have not been clear enough 😅
The references get broken whenever they point inside a dropdown. Cross-references from the dropdown to the outside (such as this one) are perfectly fine!
The underlying issue is that the dropdown has to be unfolded for mozilla to access the reference.
There was a problem hiding this comment.
No probs! I've updated the references to topic directives when required (assuming I understood correctly this time. If not, no problem and we'll keep modifying the rst)
512c604 to
b2a99d4
Compare
|
Thanks for the helpful tips and comments, Arturo! Talk to you soon in another contribution |
Reference Issues/PRs
Towards #26617.
What does this implement/fix? Explain your changes.
This PR implements the dropdowns in section 3.3, using the resources of #26625. The only file that had to been modified is
model_evaluation.rst.Thank you!
Any other comments?