8000 [MRG+1] Improved docstring for permutation_test_score (#8379 and #8564) by leereeves · Pull Request #8569 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

[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

Merged
merged 2 commits into from
Mar 12, 2017
Merged

[MRG+1] Improved docstring for permutation_test_score (#8379 and #8564) #8569

merged 2 commits into from
Mar 12, 2017

Conversation

leereeves
Copy link
Contributor
@leereeves leereeves commented Mar 10, 2017

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.

@jnothman
Copy link
Member

LGTM, thanks

@jnothman jnothman changed the title Improved docstring for permutation_test_score (#8379 and #8564) [MRG+1] Improved docstring for permutation_test_score (#8379 and #8564) Mar 11, 2017
Copy link
Member
@raghavrv raghavrv left a 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...

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
Copy link
Member

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
Copy link
Member

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...

@leereeves
Copy link
Contributor Author

Thanks for the correction. Changes ready.

@jnothman jnothman merged commit cd66c5a into scikit-learn:master Mar 12, 2017
@jnothman
Copy link
Member

Thanks @leereeves!

@leereeves leereeves changed the title [MRG+1] Improved docstring for permutation_test_score (#8379 and #8564) [MRG+1] Improved docstring for permutation_test_score (Resolve #8379 and #8564) Mar 14, 2017
@leereeves leereeves changed the title [MRG+1] Improved docstring for permutation_test_score (Resolve #8379 and #8564) [MRG+1] Improved docstring for permutation_test_score (#8379 and #8564) Mar 14, 2017
@Przemo10 Przemo10 mentioned this pull request Mar 17, 2017
jwjohnson314 pushed a commit to jwjohnson314/scikit-learn that referenced this pull request Dec 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0