DOC Improve docstrings for scikit-learn configuration functions #31486
+53
−18
Conversation
This file contains hidden or 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
…onfig, config_context)
adrinjalali
reviewed
Jun 12, 2025
Comment on lines
+81
to
+82
| This function can be used to modify the global scikit-learn configuration at this | ||
| runtime. Passing `None` as an argument (the default) leaves the corresponding |
There was a problem hiding this comment.
Suggested change
| This function can be used to modify the global scikit-learn configuration at this | |
| runtime. Passing `None` as an argument (the default) leaves the corresponding | |
| This function can be used to modify the global scikit-learn configuration at | |
| runtime. Passing `None` as an argument (the default) leaves the corresponding |
Comment on lines
+256
to
+258
| It is recommended to use this context manager over :func:`set_config` for | ||
| experimental features (such as `array_api_dispatch` or `enable_metadata_routing`), | ||
| as their support is not yet consistently available across the library. |
There was a problem hiding this comment.
That's not true. Using context managers for such settings actually probably results in confusion. I'd remove the paragraph.
There was a problem hiding this comment.
Genuine question, I didn't realise this? In the array API docs this is what we seem to suggest: https://scikit-learn.org/dev/modules/array_api.html#pytorch-support
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 improves the docstrings of
set_config,get_config,config_context, to help users understand how to use them.Specifically:
None) and global defaults