Skip to content

Added automatic validation function for sklearn.neighbors.radius_neighbors_graph (#24862) #27245

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 13 commits into from
Sep 5, 2023
Merged

Added automatic validation function for sklearn.neighbors.radius_neighbors_graph (#24862) #27245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7343d72
Update _graph.py
sqali Aug 30, 2023
407baae
Update test_public_functions.py
sqali Aug 30, 2023
a8b04d1
Update _graph.py
sqali Aug 30, 2023
4bd4d67
file reformatting done using black, mypy, added prefer_skip argument
sqali Aug 31, 2023
782a44a
removed balltree from the x parameters
sqali Aug 31, 2023
ec57870
Merge branch 'main' into main
sqali Aug 31, 2023
785bab3
Update v1.4.rst
sqali Sep 1, 2023
2f86295
Update sklearn/neighbors/_graph.py
sqali Sep 1, 2023
f781cd8
Update sklearn/neighbors/_graph.py
sqali Sep 1, 2023
1537473
Update v1.4.rst
sqali Sep 1, 2023
27033b6
Merge branch 'main' into main
sqali Sep 1, 2023
ce2cf5c
fix docstring
jeremiedbb Sep 1, 2023
5bf1c77
Merge branch 'main' of https://github.com/sqali/scikit-learn into pr/…
jeremiedbb Sep 1, 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
20 changes: 16 additions & 4 deletions sklearn/neighbors/_graph.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ def kneighbors_graph(
Parameters
----------
X : array-like of shape (n_samples, n_features)
Sample data, in the form of a numpy array.
Sample data.

n_neighbors : int
Number of neighbors for each sample.
Expand Down Expand Up @@ -148,6 +148,19 @@ def kneighbors_graph(
return X.kneighbors_graph(X=query, n_neighbors=n_neighbors, mode=mode)


@validate_params(
{
"X": ["array-like", RadiusNeighborsMixin],
"radius": [Interval(Real, 0, None, closed="both")],
"mode": [StrOptions({"connectivity", "distance"})],
"metric": [StrOptions(set(itertools.chain(*VALID_METRICS.values()))), callable],
"p": [Interval(Real, 0, None, closed="right"), None],
"metric_params": [dict, None],
"include_self": ["boolean", StrOptions({"auto"})],
"n_jobs": [Integral, None],
},
prefer_skip_nested_validation=False, # metric is not validated yet
)
def radius_neighbors_graph(
X,
radius,
Expand All @@ -168,9 +181,8 @@ def radius_neighbors_graph(

Parameters
----------
X : array-like of shape (n_samples, n_features) or BallTree
Sample data, in the form of a numpy array or a precomputed
:class:`BallTree`.
X : array-like of shape (n_samples, n_features)
Sample data.

radius : float
Radius of neighborhoods.
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 @@ -306,6 +306,7 @@ def _check_function_param_validation(
"sklearn.model_selection.train_test_split",
"sklearn.model_selection.validation_curve",
"sklearn.neighbors.kneighbors_graph",
"sklearn.neighbors.radius_neighbors_graph",
"sklearn.neighbors.sort_graph_by_row_values",
"sklearn.preprocessing.add_dummy_feature",
"sklearn.preprocessing.binarize",
Expand Down