Skip to content

MAINT Parameters validation for graph.single_source_shortest_path_length #26091

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
Jun 27, 2023
Merged

MAINT Parameters validation for graph.single_source_shortest_path_length #26091

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
b358b7d
MAINT Parameters validation for graph.single_source_shortest_path_length
ChVeen Apr 4, 2023
a200837
Merge branch 'main' into Parameters-validation-for-single_source_shor…
glemaitre Apr 14, 2023
b582530
MAINT bump the minimum pytest version
glemaitre Apr 14, 2023
aaaa617
Merge remote-tracking branch 'origin/main' into pr/ChVeen/26091
glemaitre Apr 14, 2023
388f310
update README
glemaitre Apr 14, 2023
90801b4
MAINT adapt docstring of single_source_shortest_path_length
ChVeen Apr 14, 2023
825faf0
MAINT updated pytest to 5.4.3 in Azure build tools files
ChVeen Apr 15, 2023
348312d
Merge branch 'main' into Parameters-validation-for-single_source_shor…
ChVeen May 6, 2023
288d339
fixed from-import line w.r.t. _param_validation
ChVeen Jun 4, 2023
8219ec9
Merge remote-tracking branch 'upstream/main' into pr/ChVeen/26091
jeremiedbb Jun 27, 2023
f745fb7
add prefer_skip_nested_validation
jeremiedbb Jun 27, 2023
1b25119
lint
jeremiedbb Jun 27, 2023
fac27b5
Merge branch 'main' into Parameters-validation-for-single_source_shor…
jeremiedbb Jun 27, 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
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 @@ -280,6 +280,7 @@ def _check_function_param_validation(
"sklearn.tree.export_text",
"sklearn.tree.plot_tree",
"sklearn.utils.gen_batches",
"sklearn.utils.graph.single_source_shortest_path_length",
"sklearn.utils.resample",
]

Expand Down
11 changes: 10 additions & 1 deletion sklearn/utils/graph.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,26 @@
from scipy import sparse

from ..metrics.pairwise import pairwise_distances
from ._param_validation import Integral, Interval, validate_params


###############################################################################
# Path and connected component analysis.
# Code adapted from networkx
@validate_params(
{
"graph": ["array-like", "sparse matrix"],
"source": [Interval(Integral, 0, None, closed="left")],
"cutoff": [Interval(Integral, 0, None, closed="left"), None],
},
prefer_skip_nested_validation=True,
)
def single_source_shortest_path_length(graph, source, *, cutoff=None):
"""Return the length of the shortest path from source to all reachable nodes.

Parameters
----------
graph : {sparse matrix, ndarray} of shape (n_nodes, n_nodes)
graph : {array-like, sparse matrix} of shape (n_nodes, n_nodes)
Adjacency matrix of the graph. Sparse matrix of format LIL is
preferred.

Expand Down