Skip to content

[MRG] DOC n_jobs descriptions for forest.py #14628

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 2 commits into from
Aug 13, 2019
Merged

[MRG] DOC n_jobs descriptions for forest.py #14628

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ffe084
n_jobs description
NicolasHug Aug 11, 2019
4579841
Used single backticks for linking + document apply and decision_pth
NicolasHug Aug 12, 2019
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: 15 additions & 5 deletions sklearn/ensemble/forest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,7 +868,9 @@ class RandomForestClassifier(ForestClassifier):
the generalization accuracy.

n_jobs : int or None, optional (default=None)
The number of jobs to run in parallel for both `fit` and `predict`.
The number of jobs to run in parallel.
`fit`, `predict`, `decision_path` and `apply` are all
parallelized over the trees.
``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
``-1`` means using all processors. See :term:`Glossary <n_jobs>`
for more details.
Expand Down Expand Up @@ -1157,7 +1159,9 @@ class RandomForestRegressor(ForestRegressor):
the R^2 on unseen data.

n_jobs : int or None, optional (default=None)
The number of jobs to run in parallel for both `fit` and `predict`.
The number of jobs to run in parallel.
`fit`, `predict`, `decision_path` and `apply` are all
parallelized over the trees.
`None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
``-1`` means using all processors. See :term:`Glossary <n_jobs>`
for more details.
Expand Down Expand Up @@ -1406,7 +1410,9 @@ class ExtraTreesClassifier(ForestClassifier):
the generalization accuracy.

n_jobs : int or None, optional (default=None)
The number of jobs to run in parallel for both `fit` and `predict`.
The number of jobs to run in parallel.
`fit`, `predict`, `decision_path` and `apply` are all
parallelized over the trees.
``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
``-1`` means using all processors. See :term:`Glossary <n_jobs>`
for more details.
Expand Down Expand Up @@ -1671,7 +1677,9 @@ class ExtraTreesRegressor(ForestRegressor):
Whether to use out-of-bag samples to estimate the R^2 on unseen data.

n_jobs : int or None, optional (default=None)
The number of jobs to run in parallel for both `fit` and `predict`.
The number of jobs to run in parallel.
`fit`, `predict`, `decision_path` and `apply` are all
parallelized over the trees.
``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
``-1`` means using all processors. See :term:`Glossary <n_jobs>`
for more details.
Expand Down Expand Up @@ -1874,7 +1882,9 @@ class RandomTreesEmbedding(BaseForest):
or to return a dense array compatible with dense pipeline operators.

n_jobs : int or None, optional (default=None)
The number of jobs to run in parallel for both `fit` and `predict`.
The number of jobs to run in parallel.
`fit`, `transform`, `decision_path` and `apply` are all
parallelized over the trees.
``None`` means 1 unless in a :obj:`joblib.parallel_backend` context.
``-1`` means using all processors. See :term:`Glossary <n_jobs>`
for more details.
Expand Down