8000 DOC Specify the meaning of default=None in cluster module by alfaro96 · Pull Request #17533 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

DOC Specify the meaning of default=None in cluster module #17533

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 1 commit into from
Jun 9, 2020
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
3 changes: 2 additions & 1 deletion sklearn/cluster/_dbscan.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,8 @@ class DBSCAN(ClusterMixin, BaseEstimator):

p : float, default=None
The power of the Minkowski metric to be used to calculate distance
between points.
between points. If None, then ``p=2`` (equivalent to the Euclidean
distance).

n_jobs : int, default=None
The number of parallel jobs to run.
Expand Down
6 changes: 4 additions & 2 deletions sklearn/cluster/_spectral.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,8 @@ def spectral_clustering(affinity, *, n_clusters=8, n_components=None,
eigen_solver : {None, 'arpack', 'lobpcg', or 'amg'}
The eigenvalue decomposition strategy to use. AMG requires pyamg
to be installed. It can be faster on very large, sparse problems,
but may also lead to instabilities
but may also lead to instabilities. If None, then ``'arpack'`` is
used.

random_state : int, RandomState instance, default=None
A pseudo random number generator used for the initialization of the
Expand Down Expand Up @@ -307,7 +308,8 @@ class SpectralClustering(ClusterMixin, BaseEstimator):
eigen_solver : {None, 'arpack', 'lobpcg', or 'amg'}
The eigenvalue decomposition strategy to use. AMG requires pyamg
to be installed. It can be faster on very large, sparse problems,
but may also lead to instabilities.
but may also lead to instabilities. If None, then ``'arpack'`` is
used.

n_components : integer, optional, default=n_clusters
Number of eigen vectors to use for the spectral embedding
Expand Down
4 changes: 3 additions & 1 deletion sklearn/manifold/_spectral_embedding.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,8 @@ def spectral_embedding(adjacency, *, n_components=8, eigen_solver=None,
eigen_solver : {None, 'arpack', 'lobpcg', or 'amg'}, default None
The eigenvalue decomposition strategy to use. AMG requires pyamg
to be installed. It can be faster on very large, sparse problems,
but may also lead to instabilities.
but may also lead to instabilities. If None, then ``'arpack'`` is
used.

random_state : int, RandomState instance, default=None
Determines the random number generator used for the initialization of
Expand Down Expand Up @@ -394,6 +395,7 @@ class SpectralEmbedding(BaseEstimator):
eigen_solver : {None, 'arpack', 'lobpcg', or 'amg'}
The eigenvalue decomposition strategy to use. AMG requires pyamg
to be installed. It can be faster on very large, sparse problems.
If None, then ``'arpack'`` is used.

n_neighbors : int, default : max(n_samples/10 , 1)
Number of nearest neighbors for nearest_neighbors graph building.
Expand Down
0