Document our Datasets

[dominic0df]

User story

1. As a team
2. I want to shortly document our datasets on Huggingface
3. So that interested users now of what they consist

Acceptance criteria

• For each dataset on hugging face a short dataset card (see https://huggingface.co/docs/hub/datasets-cards) / README.md is created
• The dataset card should at least contain
  • a short description what the dataset is about, e.g. where does the data come from or how it is generated
  • that it is available under a MIT license (the license that we use)
  • a link to our GitHub repo
  • Optional: Tag the data if you find suitable tags
  • Documentation in our Wiki Page
  • The datasets are documented in our GitHub Wiki page as well (just use the description that you have already written for Huggingface) and are referenced by a link to the Huggingface repo
  • The dataset documentation is part of our design documentation

Definition of done (DoD)

• Bill of Materials in the planning document has been updated
• All feature branches have been merged and closed
• New feature code has been documented
• Potential new licenses have been checked
• All GitHub Actions are passing
• The requirement.txt is updated

DoD general criteria

• Feature has been fully implemented
• Feature has been merged into the mainline
• All acceptance criteria were met
• Product owner approved features
• All tests are passing
• Developers agreed to release