10000 DOC Add description for the meaning of `None` for check_X_y by ricmperes · Pull Request #25997 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Add description for the meaning of None for check_X_y #25997

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
Merged
merged 9 commits into from
Aug 11, 2023
Merged

DOC Add description for the meaning of None for check_X_y #25997

merged 9 commits into from
Aug 11, 2023

Conversation

ricmperes
Copy link
Contributor

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Adds to the fixes of #17295. A descriptor for the argument None is added for the method sklearn.utils.check_X_y.

Any other comments?

@betatim
Copy link
Member
betatim commented Mar 28, 2023

In #17295 (comment) you said you'd work on

scikit-learn/sklearn/utils/validation.py

Line 998 in 9ed51ce

def check_X_y(
but you edited sklearn/utils/_mocking.py. I think it is a good idea to update this PR to edit the file you said you'd edit.

glemaitre
glemaitre reviewed Mar 29, 2023
View reviewed changes
Copy link
Member
@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

We can always update the documentation of the mocking class. But indeed check_X_y is indeed the function leaving in sklearn.utils.

@glemaitre glemaitre changed the title [DOC] Add None descriptor for check_X_y DOC Add description for the meaning of None for check_X_y Mar 29, 2023
@marenwestermann
Copy link
Member

@ricmperes are you planning to continue working on this PR?

@ricmperes
Copy link
Contributor Author

@marenwestermann thanks for the tagging! I can work on this some more now, will commit updates soon.

@github-actions
Copy link
github-actions bot commented Jun 30, 2023 •
edited
Loading

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 79716f0. Link to the linter CI: here

@ricmperes ricmperes closed this Jun 30, 2023
@ricmperes ricmperes deleted the _check_X_y-DOC-None-fix branch June 30, 2023 15:50
@ricmperes ricmperes restored the _check_X_y-DOC-None-fix branch June 30, 2023 15:53
@ricmperes ricmperes reopened this Jun 30, 2023
@ricmperes ricmperes requested a review from glemaitre June 30, 2023 16:00
thomasjpfan
thomasjpfan reviewed 8000 Jul 26, 2023
View reviewed changes
Copy link
Member
@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Thank you for the PR!

thomasjpfan
thomasjpfan approved these changes Aug 7, 2023
View reviewed changes
Copy link
Member
@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Otherwise LGTM

@ricmperes @thomasjpfan
DOC nit in sklearn/utils/_mocking.py
79716f0 
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
@glemaitre glemaitre merged commit 8c59089 into scikit-learn:main Aug 11, 2023
@glemaitre
Copy link
Member

Thanks @ricmperes. Merging.

TamaraAtanasoska pushed a commit to TamaraAtanasoska/scikit-learn that referenced this pull request Aug 21, 2023
@ricmperes @thomasjpfan @TamaraAtanasoska
DOC Add description for the meaning of None for check_X_y (scikit-l…
04ebe17 
…earn#25997)

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
akaashpatelmns pushed a commit to akaashp2000/scikit-learn that referenced this pull request Aug 25, 2023
@ricmperes @thomasjpfan @akaashpatelmns
DOC Add description for the meaning of None for check_X_y (scikit-l…
f2ed653 
…earn#25997)

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Sep 18, 2023
@ricmperes @thomasjpfan @glemaitre
DOC Add description for the meaning of None for check_X_y (scikit-l…
0371e19 
…earn#25997)

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
jeremiedbb pushed a commit that referenced this pull request Sep 20, 2023
@ricmperes @thomasjpfan @jeremiedbb
DOC Add description for the meaning of None for check_X_y (#25997)
ad423f2 
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
REDVM pushed a commit to REDVM/scikit-learn that referenced this pull request Nov 16, 2023
@ricmperes @thomasjpfan @REDVM
DOC Add description for the meaning of None for check_X_y (scikit-l…
e369e8e 
…earn#25997)

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomasjpfan thomasjpfan thomasjpfan approved these changes

@glemaitre glemaitre Awaiting requested review from glemaitre

Assignees
No one assigned
Labels
Documentation module:utils
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@ricmperes @betatim @marenwestermann @glemaitre @thomasjpfan @Micky774
0