8000 DOC Linear regression n_jobs doc update (#21258) · glemaitre/scikit-learn@d962049 · GitHub
[go: up one dir, main page]

Skip to content

Commit d962049

Browse files
simonandrasthomasjpfanjjerphan
authored andcommitted
DOC Linear regression n_jobs doc update (scikit-learn#21258)
* update docstring * Apply suggestions from code review Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> * Update sklearn/linear_model/_base.py Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
1 parent 57fa875 commit d962049

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

sklearn/linear_model/_base.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -536,10 +536,11 @@ class LinearRegression(MultiOutputMixin, RegressorMixin, LinearModel):
536536
537537
n_jobs : int, default=None
538538
The number of jobs to use for the computation. This will only provide
539-
speedup for n_targets > 1 and sufficient large problems.
540-
``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
541-
``-1`` means using all processors. See :term:`Glossary <n_jobs>`
542-
for more details.
539+
speedup in case of sufficiently large problems, that is if firstly
540+
`n_targets > 1` and secondly `X` is sparse or if `positive` is set
541+
to `True`. ``None`` means 1 unless in a
542+
:obj:`joblib.parallel_backend` context. ``-1`` means using all
543+
processors. See :term:`Glossary <n_jobs>` for more details.
543544
544545
positive : bool, default=False
545546
When set to ``True``, forces the coefficients to be positive. This

0 commit comments

Comments
 (0)
0