-
Notifications
You must be signed in to change notification settings - Fork 413
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
DOC add public documentation for parallel_backend #1481
Conversation
Codecov ReportPatch coverage has no change and project coverage change:
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
☔ View full report in Codecov by Sentry. |
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? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
Yep, I can do that. Currently all our docstring in scikit-learn are the following:
So I assume that we should replace it by |
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: ***@***.***>
|
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thx @glemaitre
I see some intersphinx warnings in scikit-learn. I assume that the reason is that the documentation is not exposed.