Skip to content

MAINT Added Parameter Validation for datasets.make_circles() #25804

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
Closed
ZeeshanLone wants to merge 0 commits into from
Closed

MAINT Added Parameter Validation for datasets.make_circles() #25804

ZeeshanLone wants to merge 0 commits into from

Conversation

@ZeeshanLone
Copy link
Contributor

@ZeeshanLone ZeeshanLone commented Mar 10, 2023

Reference Issues/PRs

Towards #24862

What does this implement/fix? Explain your changes.

Added parameter validation for datasets.make_circle

Any other comments?

Tests passed flake8 ./sklearn/datasets/_samples_generator.py, pytest -vl sklearn/tests/test_public_functions.py

@jeremiedbb jeremiedbb added No Changelog Needed Validation related to input validation labels Mar 13, 2023
jeremiedbb
jeremiedbb reviewed Mar 13, 2023
View reviewed changes
Copy link
Member

@jeremiedbb jeremiedbb 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 @still-learning-ev. Here are a couple of comments

sklearn/datasets/_samples_generator.py Outdated
"shuffle": ["boolean"],
"noise": [Interval(Real, 0, None, closed="left"), None],
"random_state": ["random_state"],
"factor": [Interval(Real, 0, 1, closed="both")],
Copy link
Member

@jeremiedbb jeremiedbb Mar 13, 2023

Choose a reason for hiding this comment

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

According to the validation on line 729, 0 is allowed and 1 is not.

Suggested change
"factor": [Interval(Real, 0, 1, closed="both")],
"factor": [Interval(Real, 0, 1, closed="left")],

You can now remove validation on line 729, and check in test_sample_generator if we check for this specific error (in which case you can remove it).

Please also fix the param description in the docstring which should be ìn the range [0, 1)

@ZeeshanLone
Copy link
Contributor Author

ZeeshanLone commented Mar 13, 2023

Thanks for the PR @still-learning-ev. Here are a couple of comments

Thanks for the suggestion @jeremiedbb

@jeremiedbb
Copy link
Member

jeremiedbb commented Mar 13, 2023

I unresolved this #25804 (comment) since the 2 second part of the comment still needs to be addressed.

@ZeeshanLone
Copy link
Contributor Author

ZeeshanLone commented Mar 14, 2023

"left": the interval is closed on the left and open on the right. It is equivalent to the interval [ left, right ) [0,1)

@ZeeshanLone ZeeshanLone mentioned this pull request Mar 15, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jeremiedbb jeremiedbb jeremiedbb left review comments

Assignees

No one assigned

Labels

module:datasets No Changelog Needed Validation related to input validation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ZeeshanLone @jeremiedbb