DOC improve model evaluation a bit #18166
Conversation
| @@ -117,7 +117,7 @@ Usage examples: | |||
|
|
|||
| .. note:: | |||
|
|
|||
| The values listed by the ValueError exception correspond to the functions measuring | |||
| The values listed by the ``ValueError`` exception correspond to the functions measuring | |||
There was a problem hiding this comment.
Just FYI we changed the meaning of single backquotes so that they have the same effect of double backquotes. I tend to use them because it's easier to read the plain text, but we don't have specific guidelines for this so do as you prefer
There was a problem hiding this comment.
Do single and double backquotes have different semantics?
There was a problem hiding this comment.
They are exactly the same now.
doc/modules/model_evaluation.rst
Outdated
| predictions. | ||
| This function returns the mean squared error of the actual outcome | ||
| :math:`y \in \{0,1\}` and the predicted probability estimate | ||
| :math:`p = \operatorname{Pr}(y = 1)` (``predict_proba``) as score: |
There was a problem hiding this comment.
We like to link to the glossary when it might make sense
| :math:`p = \operatorname{Pr}(y = 1)` (``predict_proba``) as score: | |
| :math:`p = \operatorname{Pr}(y = 1)` (:term:`predict_proba`) as score: |
I would also add "as outputed by ..."
There was a problem hiding this comment.
I replaced "as score" by "as outputted by" because, as you pointed out, it is a loss, not a score in scikit-learn terms.
|
@NicolasHug Thanks for your fast review. |
| @@ -117,7 +117,7 @@ Usage examples: | |||
|
|
|||
| .. note:: | |||
|
|
|||
| The values listed by the ValueError exception correspond to the functions measuring | |||
| The values listed by the ``ValueError`` exception correspond to the functions measuring | |||
There was a problem hiding this comment.
They are exactly the same now.
|
@thomasjpfan Thanks for review an approval. |
What does this implement/fix? Explain your changes.
This improves the User Guide about model evaluation a little bit.
Any other comments?
Inspired by reading #18051.