Update documentation of XML files for task upload
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 755
- Forks
- 128
- PR merge metrics
- No merged PRs in 30d
Description
Please provide more complete documentation on how the XML file for task uploads should look like. The example https://www.openml.org/api/v1/xml_example/task is okay, but the spec https://www.openml.org/api/v1/xsd/openml.task.upload cannot act as a definition. Also, the role of the evaluation_measures field remains unclear.
Task upload is important. If you expect people to upload data, then they also need to define a default task for the data. Therefore, please fix.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the XML example at https://www.openml.org/api/v1/xml_example/task with the schema at https://www.openml.org/api/v1/xsd/openml.task.upload. Document the expected task-upload XML, explain the role of evaluation_measures, and clarify how a default task should be defined; the documentation is done when these upload requirements are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100