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

OpenMLSplit.__init__ not documented or tested #332

Open
amueller opened this issue Oct 9, 2017 · 4 comments · May be fixed by #1385
Open

OpenMLSplit.__init__ not documented or tested #332

amueller opened this issue Oct 9, 2017 · 4 comments · May be fixed by #1385
Labels
Documentation Good First Issue Issues suitable for people new to contributing to openml-python!

Comments

@amueller
Copy link
Contributor

amueller commented Oct 9, 2017

Any instantiation of OpenMLSplit is done via a private function in the code. That seems really weird. And the class is not really documented.

@mfeurer mfeurer added the Good First Issue Issues suitable for people new to contributing to openml-python! label Oct 16, 2017
@cosmologist10
Copy link

Hey @amueller! I want to work on this issue, can you explain what exactly i need to do.
Thanks!

@mfeurer
Copy link
Collaborator

mfeurer commented Nov 30, 2017

@amueller basically mentions two issues:

  1. split.py has absolutely no documentation - no docstrings whatsoever: https://openml.github.io/openml-python/stable/generated/openml.OpenMLSplit.html#openml.OpenMLSplit
    I'm pretty sure that Andy would like to have a general docstring here to have the class and its methods explained.
  2. The class being instantiated in a private method of a different class. This is actually not correct: https://github.com/openml/openml-python/blob/master/openml/tasks/task.py#L83
    Also, I'm not sure why this would be an issue.

Therefore, it would be great if you add some documentation to the class, maybe @amueller can comment on issue number two in the meantime. Unfortunately, the documentation on OpenML.org is a bit sparse ATM, but you can find some improvements made by Andy, including a description of what a split and a task is, here: openml/openml.org#210

If you have any questions please do not hesitate to ask.

@amueller
Copy link
Contributor Author

Sorry if I wasn't clear on the second issue.
My problem was that you can not construct an OpenMLSplit object class, or at least it's not clear to me how. The line you're listing is exactly what I meant. It's a private class method of OpenMLSplit. The only way to create an OpenMLSplit that I can see is calling OpenMLSplit._from_arff_file.

I guess in general that would be fine as a pattern, but I just found it pretty confusing. I guess we can't currently create tasks from the Python interface, so there is no reason why anyone would create a split. If we were to create tasks in Python, I would imagine that somehow would involve creating a split?

@mfeurer
Copy link
Collaborator

mfeurer commented Dec 4, 2017

Given the this is necessary to create new tasks I can see your confusion and why we need documentation on how the split class can be instantiated.

@VHemanth45 VHemanth45 linked a pull request Dec 11, 2024 that will close this issue
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

Successfully merging a pull request may close this issue.

3 participants