doc(interpretation linear model): small changes #31760
Conversation
| @@ -289,11 +290,12 @@ | |||
| # %% | |||
| # Now that the coefficients have been scaled, we can safely compare them. | |||
| # | |||
| # .. warning:: | |||
| # .. note:: | |||
There was a problem hiding this comment.
The term warning to me seemed to show that something was wrong in this example. (and the questions, without answer, seemed to indicate that too).
There was a problem hiding this comment.
Good catch, that did look strange before.
Maybe like this?
| # .. note:: | |
| # .. admonition:: Questions |
That sets a custom title, see https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html.
It could also be .. hint::?
| # model using, for example, the median absolute error of the model and the R | ||
| # squared coefficient. |
There was a problem hiding this comment.
no trace of R² below.
| # the above example, we do not need to scale the coefficients by the std. dev. | ||
| # of the feature values since this scaling was already | ||
| # done in the preprocessing step of the pipeline. |
There was a problem hiding this comment.
redundant with a couple of lines above + the title of the section.
examples/inspection/plot_linear_model_coefficient_interpretation.py
Outdated
Show resolved
Hide resolved
examples/inspection/plot_linear_model_coefficient_interpretation.py
Outdated
Show resolved
Hide resolved
examples/inspection/plot_linear_model_coefficient_interpretation.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
These are very valuable clarifications, thanks a lot @MarieSacksick! 😃
I only have a few minor comments and a question on the last sentence from the "Lessons learned" section.
examples/inspection/plot_linear_model_coefficient_interpretation.py
Outdated
Show resolved
Hide resolved
examples/inspection/plot_linear_model_coefficient_interpretation.py
Outdated
Show resolved
Hide resolved
| @@ -289,11 +290,12 @@ | |||
| # %% | |||
| # Now that the coefficients have been scaled, we can safely compare them. | |||
| # | |||
| # .. warning:: | |||
| # .. note:: | |||
There was a problem hiding this comment.
Good catch, that did look strange before.
Maybe like this?
| # .. note:: | |
| # .. admonition:: Questions |
That sets a custom title, see https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html.
It could also be .. hint::?
examples/inspection/plot_linear_model_coefficient_interpretation.py
Outdated
Show resolved
Hide resolved
examples/inspection/plot_linear_model_coefficient_interpretation.py
Outdated
Show resolved
Hide resolved
examples/inspection/plot_linear_model_coefficient_interpretation.py
Outdated
Show resolved
Hide resolved
…on.py Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
…on.py Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
…earn#31760) Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
Reference Issues/PRs
What does this implement/fix? Explain your changes.
Reading this example, I found some small elements that would benefit a change.
Any other comments?