DOC move "Global configurations" out of parallelism.rst and into its own site - #34246
Conversation
|
@AnneBeyer and @ArturoAmorQ, would you like to have a look? |
AnneBeyer
left a comment
There was a problem hiding this comment.
Thank you, @StefanieSenger! This makes a lot of sense and the new structure is much clearer than before.
One small suggestion below, otherwise LGTM!
@ArturoAmorQ or @lesteve, could you have a look as well?
jeremiedbb
left a comment
There was a problem hiding this comment.
Thanks for the PR. Just a small remark. Looks good otherwise
| :ref:`SKLEARN_WORKING_MEMORY <envvar_SKLEARN_WORKING_MEMORY>` sets the default value for | ||
| the `working_memory` argument of :func:`sklearn.set_config`. See | ||
| :ref:`global_configuration` for this and other scikit-learn configuration environment | ||
| variables. |
There was a problem hiding this comment.
working_memory is not what controls the behavior of joblib's auto-memmapping. To control it you need to use joblib.parallel_config(max_nbytes=...) for instance.
working_memory is not related to parallelism. It limits the size of intermediate arrays in a a few specific places in sklearn (I believe only stuff related to pairwise distances + argmin currently).
|
It kind of makes sense because the filename does not make any sense. At the same I personally I kind of like the fact that all the |
|
Having said this, I am willing to override myself (or be overriden by another maintainer) because I think we have a lot of room for improvement to be less conservative/more adventurous in general, and in particular for things that have no effect whatsoever on users. Developer docs is a good example of such a place IMO. It doesn't affect users and Anne thought this was better like this, sure why not, let's do this, bim merged. In this PR's case, there are micro-impacts on the user e.g. |
thomasjpfan
left a comment
There was a problem hiding this comment.
Overall, I am +1 on putting all the environment variables in one place (also out of parallelism.rst).
What does this implement/fix? Explain your changes.
This PR moves the section on global configurations and environment variables out of
parallelism.rstwhere it had organically grown into more than just variables for parallel execution. Now it deserves its own little place. :)This is almost a pure migration PR, contents did not change, just the order of the environment variables, which are now grouped.
SKLEARN_SKIP_OPENMP_TESTandSKLEARN_TEST_NO_OPENMPwhich are relatively new, are added with a short description.AI usage disclosure
I used AI assistance for:
My Agent did this PR, but I checked that