Skip to content

Added user guide documentation for permutation_test_score #10905#14769

Closed
vmanisha wants to merge 6 commits intoscikit-learn:masterfrom
vmanisha:fix-10905
Closed

Added user guide documentation for permutation_test_score #10905#14769
vmanisha wants to merge 6 commits intoscikit-learn:masterfrom
vmanisha:fix-10905

Conversation

@vmanisha
Copy link
Copy Markdown

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?

Copy link
Copy Markdown
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR,

Only nitpicks for now, I'll look at it into more details later but it looks good.

Doc building is failing on the CI, not sure why yet

['estimator', 'fit_time', 'score_time', 'test_score', 'train_score']

Cross-validation significance evaluation
----------------------------------------
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add this section after "Obtaining predictions by cross-validation"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in PR #14757.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following pep8, we try to keep the first sentence to 1 line.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in PR #14757.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Closing this pull request in favour of #14757

@vmanisha vmanisha closed this Aug 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

permutation_test_score has no user guide

4 participants