Skip to content

MAINT Parameters validation for datasets.make_blobs #25983

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

Merged
merged 6 commits into from Mar 30, 2023
Merged

MAINT Parameters validation for datasets.make_blobs #25983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0059759
add parameters validation to datasets.make_blobs
Mar 27, 2023
e3772f5
Merge branch 'main' into parameters_validation_make_blobs
glemaitre Mar 29, 2023
160806c
Update sklearn/tests/test_public_functions.py
glemaitre Mar 29, 2023
6bcaf39
update centers type to array-like in docstring
Mar 29, 2023
f23cd90
remove try except to improve readability
Mar 29, 2023
a32c13b
remove redundant else and unindent block
Mar 29, 2023
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
29 changes: 19 additions & 10 deletions sklearn/datasets/_samples_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,6 +855,18 @@ def make_moons(n_samples=100, *, shuffle=True, noise=None, random_state=None):
return X, y


@validate_params(
{
"n_samples": [Interval(Integral, 1, None, closed="left"), "array-like"],
"n_features": [Interval(Integral, 1, None, closed="left")],
"centers": [Interval(Integral, 1, None, closed="left"), "array-like", None],
"cluster_std": [Interval(Real, 0, None, closed="left"), "array-like"],
"center_box": [tuple],
"shuffle": ["boolean"],
"random_state": ["random_state"],
"return_centers": ["boolean"],
}
)
def make_blobs(
n_samples=100,
n_features=2,
Expand Down Expand Up @@ -884,7 +896,7 @@ def make_blobs(
n_features : int, default=2
The number of features for each sample.

centers : int or ndarray of shape (n_centers, n_features), default=None
centers : int or array-like of shape (n_centers, n_features), default=None
The number of centers to generate, or the fixed center locations.
If n_samples is an int and centers is None, 3 centers are generated.
If n_samples is array-like, centers must be
Expand Down Expand Up @@ -967,22 +979,19 @@ def make_blobs(
centers = generator.uniform(
center_box[0], center_box[1], size=(n_centers, n_features)
)
try:
assert len(centers) == n_centers
except TypeError as e:
if not isinstance(centers, Iterable):
raise ValueError(
"Parameter `centers` must be array-like. Got {!r} instead".format(
centers
)
) from e
except AssertionError as e:
)
if len(centers) != n_centers:
raise ValueError(
"Length of `n_samples` not consistent with number of "
f"centers. Got n_samples = {n_samples} and centers = {centers}"
) from e
else:
centers = check_array(centers)
n_features = centers.shape[1]
)
centers = check_array(centers)
n_features = centers.shape[1]

# stds: if cluster_std is given as list, it must be consistent
# with the n_centers
Expand Down
1 change: 1 addition & 0 deletions sklearn/tests/test_public_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ def _check_function_param_validation(
"sklearn.datasets.load_svmlight_file",
"sklearn.datasets.load_svmlight_files",
"sklearn.datasets.make_biclusters",
"sklearn.datasets.make_blobs",
"sklearn.datasets.make_checkerboard",
"sklearn.datasets.make_circles",
"sklearn.datasets.make_classification",
Expand Down