Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MAINT parameter validation for sklearn.datasets.dump_svmlight_file #25726

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 5 commits into from
Feb 28, 2023
Merged

MAINT parameter validation for sklearn.datasets.dump_svmlight_file #25726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0a15321
add parameter validation to dump_svmlight_file
Shivachauhan17 Feb 28, 2023
c012f1f
Merge branch 'main' into param_val_dump_svmlight_file
Shivachauhan17 Feb 28, 2023
a3c8199
fix constraints
jeremiedbb Feb 28, 2023
c471fe7
boolean
jeremiedbb Feb 28, 2023
220d684
lint
jeremiedbb Feb 28, 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
18 changes: 15 additions & 3 deletions sklearn/datasets/_svmlight_format_io.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
from .. import __version__

from ..utils import check_array, IS_PYPY
from ..utils._param_validation import validate_params, HasMethods

if not IS_PYPY:
from ._svmlight_format_fast import (
Expand Down Expand Up @@ -404,6 +405,17 @@ def _dump_svmlight(X, y, f, multilabel, one_based, comment, query_id):
)


@validate_params(
{
"X": ["array-like", "sparse matrix"],
"y": ["array-like", "sparse matrix"],
"f": [str, HasMethods(["write"])],
"zero_based": ["boolean"],
"comment": [str, bytes, None],
"query_id": ["array-like", None],
"multilabel": ["boolean"],
}
)
def dump_svmlight_file(
X,
y,
Expand All @@ -428,7 +440,7 @@ def dump_svmlight_file(
Training vectors, where `n_samples` is the number of samples and
`n_features` is the number of features.

y : {array-like, sparse matrix}, shape = [n_samples (, n_labels)]
y : {array-like, sparse matrix}, shape = (n_samples,) or (n_samples, n_labels)
Target values. Class labels must be an
integer or float, or array-like objects of integer or float for
multilabel classifications.
Expand All @@ -442,7 +454,7 @@ def dump_svmlight_file(
Whether column indices should be written zero-based (True) or one-based
(False).

comment : str, default=None
comment : str or bytes, default=None
Comment to insert at the top of the file. This should be either a
Unicode string, which will be encoded as UTF-8, or an ASCII byte
string.
Expand All @@ -459,7 +471,7 @@ def dump_svmlight_file(
https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multilabel.html).

.. versionadded:: 0.17
parameter *multilabel* to support multilabel datasets.
parameter `multilabel` to support multilabel datasets.
"""
if comment is not None:
# Convert comment string to list of lines in UTF-8.
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 @@ -102,6 +102,7 @@ def _check_function_param_validation(
"sklearn.cluster.ward_tree",
"sklearn.covariance.empirical_covariance",
"sklearn.covariance.shrunk_covariance",
"sklearn.datasets.dump_svmlight_file",
"sklearn.datasets.fetch_california_housing",
"sklearn.datasets.fetch_kddcup99",
"sklearn.datasets.make_classification",
Expand Down