DOC add public documentation for parallel_backend

[glemaitre]

I see some intersphinx warnings in scikit-learn. I assume that the reason is that the documentation is not exposed.

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -0.11 ⚠️

Comparison is base (3c314c1) 94.86% compared to head (45e767e) 94.75%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1481      +/-   ##
==========================================
- Coverage   94.86%   94.75%   -0.11%     
==========================================
  Files          45       45              
  Lines        7474     7474              
==========================================
- Hits         7090     7082       -8     
- Misses        384      392       +8     

Impacted Files	Coverage Δ
joblib/parallel.py	96.90% <ø> (ø)

... and 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[GaelVaroquaux]

I guess that for these reasons (intersphinx warnings) we should expose parallel_backend in our documentation. Our thinking was that we want to move users away from it.

@tomMoral : do you approve?

[tomMoral]

Yes the goal was to make it clear it was not supposed to be used anymore.
But indeed, for these reason we should keep it in the doc.

Can you simply move it to a new deprecated subsection at the end of the references?

[glemaitre]

Yep, I can do that.

Currently all our docstring in scikit-learn are the following:

n_jobsint, default=None
    The number of jobs to run in parallel.
    None means 1 unless in a joblib.parallel_backend context.
    -1 means using all processors.

So I assume that we should replace it by joblib.parallel_config?

[GaelVaroquaux]

Yes indeed for replacing by parallel_config

…

On Jul 5, 2023, 23:03, at 23:03, Guillaume Lemaitre ***@***.***> wrote: Yep, I can do that. Currently all our docstring in scikit-learn are the following: ``` n_jobsint, default=None The number of jobs to run in parallel. None means 1 unless in a joblib.parallel_backend context. -1 means using all processors. ``` So I assume that we should replace it by `joblib.parallel_config`? -- Reply to this email directly or view it on GitHub: #1481 (comment) You are receiving this because you commented. Message ID: ***@***.***>

[glemaitre]

I slightly change the template of the navigation bar to make it explicit which part is deprecated.

I also add a more obvious warning in parallel_backend.

[tomMoral]

LGTM, thx @glemaitre