[tune] Fix Analysis.dataframe() documentation and enable passing of mode=None
#18850
Conversation
This file contains 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
krfricke
changed the title
Analysis.dataframe()` documentation and enable passing o…Analysis.dataframe() documentation and enable passing of mode=None`
krfricke
changed the title
Analysis.dataframe() documentation and enable passing of mode=None`Analysis.dataframe() documentation and enable passing of mode=None
Yard1
approved these changes
Sep 23, 2021
| @@ -343,6 +355,7 @@ def _retrieve_rows(self, | |||
| metric: Optional[str] = None, | |||
| mode: Optional[str] = None) -> Dict[str, Any]: | |||
| assert mode is None or mode in ["max", "min"] | |||
| assert not mode or metric | |||
There was a problem hiding this comment.
Is this supposed to be !mode or metric or !(mode or metric)? Could we use parenthesis here to make it clearer?
There was a problem hiding this comment.
It is supposed to be !mode or metric i.e. if mode is set, metric has to be set as well
6 tasks
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.
Why are these changes needed?
cc @amogkam
Related issue number
Closes #17923
Checks
scripts/format.shto lint the changes in this PR.