MNT Param validation: do not expose internal values in error msg #23459
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
jjerphan
approved these changes
May 30, 2022
jjerphan
reviewed
May 31, 2022
ogrisel
pushed a commit
to ogrisel/scikit-learn
that referenced
this pull request
Jul 11, 2022
…kit-learn#23459) * allow to not expose internal valid params in error msg * ensure deprecated and internal do not overlap * deprecated and internal must be subsets of options * black
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.
We have valid values for parameters that are for internal purpose (e.g. "warn" or "deprecated") and I don't think we should expose them in the error message raised by the param validation.
for instance we currently have (since we merged #23038)
With this PR, the message becomes
Also, suppose you have a param that only accepts integers. If we deprecate it, it will accept the string "deprecated". I don't think we want the error message to mention that a str is a valid type at all.
I propose to add a param
internaltoStrOptionssuch that values that are listed ininternalwon't be exposed and if all options are internal options, even the fact that a str is valid is not exposed.