8000 DOC add more details for `n_jobs` in MeanShift docstring (#25083) · scikit-learn/scikit-learn@9a98487 · GitHub
[go: up one dir, main page]

Skip to content

Commit 9a98487

Browse files
authored
DOC add more details for n_jobs in MeanShift docstring (#25083)
* Doc changed n_init to n_jobs in mean_shift.py
1 parent 981e728 commit 9a98487

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

sklearn/cluster/_mean_shift.py

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,15 @@ def mean_shift(
176176
operation terminates (for that seed point), if has not converged yet.
177177
178178
n_jobs : int, default=None
179-
The number of jobs to use for the computation. This works by computing
180-
each of the n_init runs in parallel.
179+
The number of jobs to use for the computation. The following tasks benefit
180+
from the parallelization:
181+
182+
- The search of nearest neighbors for bandwidth estimation and label
183+
assignments. See the details in the docstring of the
184+
``NearestNeighbors`` class.
185+
- Hill-climbing optimization for all seeds.
186+
187+
See :term:`Glossary <n_jobs>` for more details.
181188
182189
``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
183190
``-1`` means using all processors. See :term:`Glossary <n_jobs>`
@@ -312,8 +319,15 @@ class MeanShift(ClusterMixin, BaseEstimator):
312319
If false, then orphans are given cluster label -1.
313320
314321
n_jobs : int, default=None
315-
The number of jobs to use for the computation. This works by computing
316-
each of the n_init runs in parallel.
322+
The number of jobs to use for the computation. The following tasks benefit
323+
from the parallelization:
324+
325+
- The search of nearest neighbors for bandwidth estimation and label
326+
assignments. See the details in the docstring of the
327+
``NearestNeighbors`` class.
328+
- Hill-climbing optimization for all seeds.
329+
330+
See :term:`Glossary <n_jobs>` for more details.
317331
318332
``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
319333
``-1`` means using all processors. See :term:`Glossary <n_jobs>`

0 commit comments

Comments
 (0)
0