DOC Clarified parallelization of plot_partial_dependence with n_jobs #19749
Conversation
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
| @@ -173,7 +173,9 @@ def plot_partial_dependence( | |||
| differences between the `'brute'` and `'recursion'` method. | |||
|
|
|||
| n_jobs : int, default=None | |||
| The number of CPUs to use to compute the partial dependences. | |||
| The number of CPUs to use to compute the partial dependences. Computation | |||
| is parallelized over specified by the `features` parameter. | |||
There was a problem hiding this comment.
Sorry my previous suggestion had poor grammar. This revised wording is also consistent with the rest of the docstring:
| is parallelized over specified by the `features` parameter. | |
| is parallelized over the target features. |
There was a problem hiding this comment.
I feel that we should avoid 'target' since that might be confused with 'label'
There was a problem hiding this comment.
I agree. I think replacing the "target features" in the docstring with "selected features" would be clearer:
| is parallelized over specified by the `features` parameter. | |
| is parallelized over the selected features. |
(I am trying to prevent the reader from thinking that we are computing the PD over all the features)
There was a problem hiding this comment.
I think referencing the features parameter is still appropriate, though, right? Why would you like to drop the specific reference to features as a parameter?
There was a problem hiding this comment.
The alternative was:
Computation is parallelized over features specified by the
featuresparameter.
which works as well.
There was a problem hiding this comment.
Agreed.
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
|
I noticed that that target branch is When we cut another release for |
|
Sure thing. The new PR is #19750 |
|
Closing in flavor of #19750 |
Reference Issues/PRs
Contributes to resolution of #14228
What does this implement/fix? Explain your changes.
Clarifies in documentation the level at which plot_partial_dependence is parallelized by n_jobs.
Any other comments?