Skip to content
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

OpenMLDataset dataset documentation is missing many properties #876

Closed
mitar opened this issue Nov 9, 2019 · 0 comments
Closed

OpenMLDataset dataset documentation is missing many properties #876

mitar opened this issue Nov 9, 2019 · 0 comments
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!

Comments

@mitar
Copy link
Member

mitar commented Nov 9, 2019

Reading here. It looks like many properties are missing. Parameters to the constructor are documented. But most of them are then copied to properties of the object. But the fact that those properties (and which, and when (when just metadata is downloaded or when also data is download) is available on the object is not really documented. I see just id and openml_url.

So it is also unclear how stable it is to access those properties, and which ones are optional and which ones are not. For example, If i call openml.datasets.get_dataset in Python API, will I always get back object with md5_checksum property set or not? What if I call openml.datasets.get_dataset with download_data=False?

@mfeurer mfeurer transferred this issue from openml/OpenML Nov 11, 2019
@ArlindKadra ArlindKadra self-assigned this Jan 24, 2020
@mfeurer mfeurer added Good First Issue Issues suitable for people new to contributing to openml-python! and removed Good First Issue Issues suitable for people new to contributing to openml-python! labels Oct 25, 2020
@mfeurer mfeurer added the Good First Issue Issues suitable for people new to contributing to openml-python! label Jun 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!
Projects
None yet
Development

No branches or pull requests

5 participants