Add field `long_description` in datasets
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 755
- Forks
- 128
- PR merge metrics
- No merged PRs in 30d
Description
While creating a new dataset, you can fill and enter a description. The placeholder recommends:
Short description (can still be edited online). Use #tags to label it. Describe where the data originates from, and whether it was processed in any way.
But today the descriptions of the datasets are really long and formatted in Markdown. What do you think about a renaming of the field description to long_description and creating a new field description which has a limited length in plain text (similar to #pypi-package-display, setup.py from PyPi).
Why? It would be great if openml-cli could provide a short and human-readable description in the result of any query and search.
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 tracing how dataset descriptions are stored and exposed during dataset creation and in query or search results. Review the openml-cli use case linked in the issue; done means a short plain-text description is available alongside the existing Markdown-capable long description, with the field naming and migration behavior agreed.
Written by the indexing model from the issue text.
Assessment
- Domain
- data, machine-learning
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100