Skip to content

DOC Update "Parallelism, resource management, and configuration" section #24997

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 8 commits into from
Nov 25, 2022

Conversation

jjerphan
Copy link
Member

@jjerphan jjerphan commented Nov 21, 2022

Reference Issues/PRs

Relates to #22587.

What does this implement/fix? Explain your changes.

Update this section of the documentation regarding latest changes, new back-ends introductions and threadpoolctl.

Any other comments?

I am thinking that it would be nice to have a list of implementations that are relying on OpenMP for parallelisation so that user which specific workflow can set appropriate values for environement variables.

Also, it would be nice to have a "label" in the documentation to know if interfaces have their implementations parallelized using joblib or OpenMP.

Note that interfaces backed by #22587 probably should have a comment in their docstrings to indicate cases where n_jobs do not apply anymore.

What do you think, @jeremiedbb, @thomasjpfan and @ogrisel?

Co-authored-by: Tim Head <betatim@gmail.com>
@jjerphan jjerphan marked this pull request as ready for review November 21, 2022 15:49
Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

Thanks for keeping this doc up to date. Here is my feedback:

jjerphan and others added 3 commits November 23, 2022 09:40
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
Copy link
Member

@ogrisel ogrisel 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 @jjerphan!

@jjerphan
Copy link
Member Author

You are welcome! @betatim, is everything clear to you?

Copy link
Member

@betatim betatim left a comment

Choose a reason for hiding this comment

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

LGTM

@lesteve lesteve merged commit 7d1c318 into scikit-learn:main Nov 25, 2022
@lesteve
Copy link
Member

lesteve commented Nov 25, 2022

Merging, thanks!

@jjerphan jjerphan deleted the doc/pdr-openmp-parallelism branch November 25, 2022 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants