MNT Always reset sckit-learn global config in examples #26340
Merged
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
betatim
approved these changes
May 8, 2023
adrinjalali
reviewed
May 8, 2023
| "inspect_global_variables": False, | ||
| "remove_config_comments": True, | ||
| "plot_gallery": "True", | ||
| "reset_modules": ("matplotlib", "seaborn", reset_sklearn_config), |
Member
There was a problem hiding this comment.
question: why can't we simply say sklearn here? Also, shouldn't numpy (and other deps maybe) be here too? One could imagine an example where numpy's print options are modified for example.
Member
There was a problem hiding this comment.
The "matplotlib" and "seaborn" are sphinx-gallery built-in reset functions. They are not implemented for every module.
Member
|
This seems indeed a lot better to do it this way. Let's merge this one, thanks! |
Member
|
I opened #26350 to tweak a comment in another example that was misleading after this PR was merged, since it was mentioning side-effects on other examples. |
REDVM
pushed a commit
to REDVM/scikit-learn
that referenced
this pull request
Nov 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 uses sphinx-gallery's reset_modules to reset the global config. This way we do not need to manually reset the global config at the end of every example.
CC @lesteve