Skip to content

MAINT Parameters validation for sklearn.preprocessing.maxabs_scale #26077

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.

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 4 commits into from
Apr 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion sklearn/preprocessing/_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -1292,6 +1292,13 @@ def _more_tags(self):
return {"allow_nan": True}


@validate_params(
{
"X": ["array-like", "sparse matrix"],
"axis": [Options(Integral, {0, 1})],
"copy": ["boolean"],
}
)
def maxabs_scale(X, *, axis=0, copy=True):
"""Scale each feature to the [-1, 1] range without breaking the sparsity.

Expand All @@ -1306,7 +1313,7 @@ def maxabs_scale(X, *, axis=0, copy=True):
X : {array-like, sparse matrix} of shape (n_samples, n_features)
The data.

axis : int, default=0
axis : {0, 1}, default=0
Axis used to scale along. If 0, independently scale each feature,
otherwise (if 1) scale each sample.

Expand Down
1 change: 1 addition & 0 deletions sklearn/tests/test_public_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ def _check_function_param_validation(
"sklearn.model_selection.train_test_split",
"sklearn.preprocessing.add_dummy_feature",
"sklearn.preprocessing.binarize",
"sklearn.preprocessing.maxabs_scale",
"sklearn.preprocessing.scale",
"sklearn.random_projection.johnson_lindenstrauss_min_dim",
"sklearn.svm.l1_min_c",
Expand Down