8000 DOC glossary on n_jobs=None semantics by jnothman · Pull Request #11806 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC glossary on n_jobs=None semantics #11806

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

Jump to bottom
Merged
merged 3 commits into from
Aug 14, 2018
Merged

DOC glossary on n_jobs=None semantics #11806

merged 3 commits into from
Aug 14, 2018

Conversation

jnothman
Copy link
Member
@jnothman jnothman commented Aug 14, 2018 •
edited by qinhanmin2014
Loading

Part of #11771

qinhanmin2014
qinhanmin2014 reviewed Aug 14, 2018
View reviewed changes
doc/conf.py Outdated
@@ -237,6 +237,7 @@
'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
'matplotlib': ('https://matplotlib.org/', None),
'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
'joblib': ('https://pythonhosted.org/joblib/', None),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be https://joblib.readthedocs.io?

@jnothman
Copy link
Member Author
jnothman commented Aug 14, 2018 via email

@qinhanmin2014
Copy link
Member

Maybe we can borrow things from their doc:None is a marker for ‘unset’ that will be interpreted as n_jobs=1 (sequential execution) unless the call is performed under a parallel_backend context manager that sets another value for n_jobs
It might be useful to emphasize that n_jobs=None means unset and will generally be interpreted as n_jobs=1.

qinhanmin2014
qinhanmin2014 approved these changes Aug 14, 2018
View reviewed changes
Copy link
Member
@qinhanmin2014 qinhanmin2014 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, ping @rth
Possible problem: we're actually using built-in joblib, so the doc might be inconsistent with our joblib in the future (before we update to the latest version).

rth
rth approved these changes Aug 14, 2018
View reviewed changes
Copy link
Member
@rth rth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@rth rth merged commit c564df9 into scikit-learn:master Aug 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rth rth rth approved these changes

@qinhanmin2014 qinhanmin2014 qinhanmin2014 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jnothman @qinhanmin2014 @rth
0