Added user guide documentation for permutation_test_score #10905 #14769
Conversation
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
NicolasHug
reviewed
Aug 24, 2019
| @@ -235,6 +235,20 @@ Here is an example of ``cross_validate`` using a single metric:: | |||
| >>> sorted(scores.keys()) | |||
| ['estimator', 'fit_time', 'score_time', 'test_score', 'train_score'] | |||
|
|
|||
| Cross-validation significance evaluation | |||
| ---------------------------------------- | |||
There was a problem hiding this comment.
I would add this section after "Obtaining predictions by cross-validation"
| @@ -871,7 +871,20 @@ def _index_param_value(X, v, indices): | |||
| def permutation_test_score(estimator, X, y, groups=None, cv=None, | |||
| n_permutations=100, n_jobs=1, random_state=0, | |||
| verbose=0, scoring=None): | |||
| """Evaluate the significance of a cross-validated score with permutations | |||
| """Evaluate the significance of a cross-validated score by permuting | |||
There was a problem hiding this comment.
Following pep8, we try to keep the first sentence to 1 line.
There was a problem hiding this comment.
Closing this pull request in favour of #14757
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
What does this implement/fix? Explain your changes.
Fixes #10905. Also see #10931. Worked on the branch https://github.com/maskani-moh/scikit-learn/tree/fix-10905.
Fix the typos from previous pull request by @aditi9783
Any other comments?