-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
[MRG+1] Improved docstring for permutation_test_score (#8379 and #8564) #8569
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[MRG+1] Improved docstring for permutation_test_score (#8379 and #8564) #8569
Conversation
LGTM, thanks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM pending minor nitpicks...
sklearn/cross_validation.py
Outdated
rather a loss function (i.e. when lower is better such as with | ||
`mean_squared_error`) then this is actually the complement of the | ||
p-value: 1 - p-value. | ||
The p-value, which approximates the probability the score would be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That the score would be
rather a loss function (i.e. when lower is better such as with | ||
`mean_squared_error`) then this is actually the complement of the | ||
p-value: 1 - p-value. | ||
The p-value, which approximates the probability the score would be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That the score would be...
Thanks for the correction. Changes ready. |
Thanks @leereeves! |
Updated docstring for permutation_test_score (pvalue section) to remove an outdated reference to loss functions (#8564) and explain why the p-value is never zero (#8379) in a way that is hopefully accessible to non machine-learning experts.
Changed in two files because I changed both the deprecated and new locations of the function.