-
-
Notifications
You must be signed in to change notification settings - Fork 132
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
Any documentation on OpenmlDataset and TaskConfig? #592
Comments
Until now, tried to write my own documentation:
As you can see, there is still many fields and methods that are unclear or throw errors |
Hi! Unfortunately, there is currently no documentation for these objects other than comments in their source code. Some, but not all, of the code has additional docstrings which clarify some of the questions you have. We recognize this makes for a bad experience and refactoring this is on our radar, as is updating our integration documentation. As most frameworks are close to ones already integrated, generally using other integrations as documentation is the easiest way to achieve a functional integration. Additionally, you may use debugging tools (breakpoints or print statements) to inspect the objects at runtime--far from ideal. The main purpose for
Hope that helps a little. If you have any questions, don't hesitate to ask. |
Hello! When looking at implementation of custom framworks in
examples
folder, I noticed that they acceptamlb.datasets.openml.OpenmlDataset
andamlb.benchmark.TaskConfig
. The first class looks different fromOpenMLDataset
from openml package, since it has another methods. Where may I find documentation for these classes?Or if there is no documentation, how do I write a custom framework?
For example,
dataset.features
seems to be a list of features, and each feature hasdata_type
field. I noticed that it may have valuescategory
andnumber
. May it have another values? Same question for all other fields.The text was updated successfully, but these errors were encountered: