Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[MRG+1] ENH/MNT Rename labels --> groups #6660

Merged
merged 5 commits into from
Sep 11, 2016
Merged

[MRG+1] ENH/MNT Rename labels --> groups #6660

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e79095d
ENH labels --> groups
raghavrv Aug 23, 2016
2d3c362
Modify group kfold docs
raghavrv Sep 11, 2016
b794354
IID doc
raghavrv Sep 11, 2016
8820e93
DOC Use Joel's wording
raghavrv Sep 11, 2016
048b640
Remove NOTE
raghavrv Sep 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions sklearn/model_selection/_validation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,8 +545,9 @@ def permutation_test_score(estimator, X, y, groups=None, cv=None,
supervised learning.

groups : array-like, with shape (n_samples,), optional
Group labels used to constrain the permutation to specific subsets of
data.
Labels to constrain permutation within groups, i.e. ``y`` values
are permuted among samples with the same group identifier.
When not specified, ``y`` values are permuted among all samples.
Copy link
Member

Choose a reason for hiding this comment

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

It'd be good to add that it's also passed to Group CV splitters...

Copy link
Member Author

Choose a reason for hiding this comment

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

I added a NOTE below specially for that ;)

Copy link
Member

Choose a reason for hiding this comment

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

Ah, sorry. Still not used to github's "viewing a subset of changes". I don't see why this is a NOTE as distinct from a parameter description, though.

Copy link
Member Author

Choose a reason for hiding this comment

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

I felt the usage of GroupCV in permutation_test_score to be not a very common usecase... Would you rather have the NOTE heading removed?

Copy link
Member

Choose a reason for hiding this comment

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

Yes.


NOTE When a grouped cross-validator is used, the group labels are
also passed on to the ``split`` method of the cross-validator. The
Expand Down