[scikit-learn] Small suggestion for documentation

Fellype fellypao at yahoo.com.br
Tue Aug 7 13:35:43 EDT 2018


Dear maintainers,I've just known scikit-learn and found it very useful. Congratulations for this library.
I found some confuse terms to describe r2_score parameters in documentation [1]. For me, the meanings of y_true and y_pred are not clear. From [1]:- y_true: ... Ground truth (correct) target values- y_pred: ... Estimated target values
Since the R^2 value is usually used to compare the behavior of experimental data (observed) with a theoretical model or standard data (expected), I guess that it would be better to change the description of y_true and y_pred to something like:- y_true: ... Observed (or measured) target values- y_pred: ... Expected (or theoretical) target values
 I also think that the same should be done in documentation of other scikit-learn functions that use the y_true and y_pred terms with the same meaning.

Thanks for your attention and best wishes.
Fellype

[1] http://scikit-learn.org/stable/modules/generated/sklearn.metrics.r2_score.html
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scikit-learn/attachments/20180807/1caf764e/attachment.html>


More information about the scikit-learn mailing list