-
-
Notifications
You must be signed in to change notification settings - Fork 147
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename argument to be more intuitive #796
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #796 +/- ##
===========================================
+ Coverage 87.71% 88.28% +0.56%
===========================================
Files 36 36
Lines 4208 4438 +230
===========================================
+ Hits 3691 3918 +227
- Misses 517 520 +3
Continue to review full report at Codecov.
|
task: Optional[List] = None, | ||
setup: Optional[List] = None, | ||
flow: Optional[List] = None, | ||
run: Optional[List] = None, | ||
uploader: Optional[List] = None, | ||
tag: Optional[str] = None, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we're going for more intuitive names, should they be changed to be plural, as they expect a list? Or perhaps even better, plural and _id
suffix (e.g. run_ids
), to indicate we are looking for something that parses to an id and not actual OpenMLX
(e.g. OpenMLRun
) objects instead?
Do we also want to change the typehint to Optionl[List[Union[str, int]]]
? It's pretty verbose, but more complete... Maybe it would be enough to include this in the docstrings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd be happy to change those, but I think this is for a future PR while this is about renaming an argument from id
to run
. Shall I open an issue so we don't forget about this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just did this so I can merge & close PR. See #804.
I didn't find a related open issue that should be closed by this PR. |
There is none. I tried to create an example and found the resulting code unintuitive so I just went ahead. Thanks for merging! |
What does this PR implement/fix? Explain your changes.
Renames argument
id
of functionopenml.evaluations.list_evaluations
torun
to make it clearer that the IDs are for the run.How should this PR be tested?
There is an existing unit test for this functionality. I updated at to reflect the changed argument name.