[CIVIS-1510] DOC call out joblib.Parallel's pre_dispatch
#443
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jacksonlee-civis
commented
Dec 6, 2021
Comment on lines
-99
to
+105
| so it will run ``pre_dispatch`` jobs at once. The default value of | ||
| ``pre_dispatch`` is "2*n_jobs", which will run a maximum of ``2 * n_jobs`` jobs | ||
| at once in the Civis Platform. Set ``pre_dispatch="n_jobs"`` in your | ||
| :class:`~joblib.Parallel` call to run at most ``n_jobs`` jobs. | ||
| so it will run ``pre_dispatch`` jobs at once. | ||
|
|
||
| .. note:: | ||
| The default value of | ||
| ``pre_dispatch`` is ``"2*n_jobs"``, which will run a maximum of ``2 * n_jobs`` jobs | ||
| at once on Civis Platform. Set ``pre_dispatch="n_jobs"`` in your | ||
| :class:`joblib.Parallel` call to run at most ``n_jobs`` jobs. |
There was a problem hiding this comment.
I suggested using a "warning" when I filed #361, but on second thought a "note" would seem more appropriate actually (a warning would be a bit too severe).
Here's what the compiled docs would look like:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR calls out the default value of
joblib.Parallel'spre_dispatchto be"2*n_jobs"(not"n_jobs") in the Sphinx docs.Closes #361
CHANGELOG.mdat the repo's root level