-
-
Notifications
You must be signed in to change notification settings - Fork 143
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
Updating examples to use names instead of integer ids whenever possible #1070
base: develop
Are you sure you want to change the base?
Conversation
Dataset ID of the dataset to download. It can be an integer or it can be a string | ||
of the dataset name. |
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.
Dataset ID of the dataset to download. It can be an integer or it can be a string | |
of the dataset name. | |
The ID or name of the dataset to download. |
Since ID's are parsed to integer anyway if they're given as strings.
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.
@PGijsbers I can also do that, however, I tried to keep it consistent with
openml-python/openml/datasets/functions.py
Lines 323 to 325 in 5669431
dataset_ids : iterable | |
Integers or strings representing dataset ids or dataset names. | |
If dataset names are specified, the least recent still active dataset version is returned. |
get_datasets
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 think the difference is fine, or should favor the simpler wording.
@PGijsbers @mfeurer While making the modifications I noticed a study that actually had no alias, can that be a case? |
An alias is not required, but I'll ask people with access if they're prepared to add one (I don't believe there's an API call for it). |
Ah thanks. Yeah, then maybe it is not worth the effort. I can just keep it like that and write a comment at the tutorial like we discussed for the datasets. |
Hey, what do you think about adding the fact that a user should always use names and version instead of the IDs when creating examples to the pull request template? (Also maybe that a warning should be emitted when using the test server, although that's not really related to this PR) |
Reference Issue
#1066, #1063
What does this PR implement/fix? Explain your changes.
get_dataset
How should this PR be tested?
Existing unit tests.