DOC Add doc for permutation_test_score#17373
Merged
ogrisel merged 2 commits intoscikit-learn:masterfrom Jul 31, 2020
Merged
Conversation
thomasjpfan
approved these changes
Jun 3, 2020
Member
thomasjpfan
left a comment
There was a problem hiding this comment.
This is an improvement. Thank you @lucyleeow !
rth
reviewed
Jun 4, 2020
| """Evaluate the significance of a cross-validated score with permutations | ||
| """Evaluates the significance of a cross-validated score using permutations | ||
|
|
||
| Read more in the :ref:`User Guide <cross_validation>`. |
Member
There was a problem hiding this comment.
We might still want to keep the link to the user manual and the end of the docstring maybe?
Member
Author
There was a problem hiding this comment.
Cross_validation (the page linked to) never talks about permutation_test_score. In fact it is never mentioned in the user guide at all. If we wanted to add a section in the user guide it would probably fit somewhere in 'Model selection and evaluation'. I'm happy to add a section but I won't have much to say and it would be the same as what I've added in the example: #17385
ogrisel
approved these changes
Jul 31, 2020
Member
ogrisel
left a comment
There was a problem hiding this comment.
LGTM, merging. Thank you very much @lucyleeow.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
closes #10905
follows from #14757
What does this implement/fix? Explain your changes.
Explains
permutation_test_scorein the docstring. I did not add an entry to the user guide as I am not sure there is much more to expand on/the docstring and example do an adequate job, but happy to do so.Happy to update/clarify the example in this or another PR.Example updated in #17385
Any other comments?