davidcanovas commented 2 years ago

Describe the bug

The info contained in the README.md file is not being shown in the dataset main page. Basic info and table of contents are properly formatted in the README.

Steps to reproduce the bug

Sample code to reproduce the bug

The README file is this one: https://huggingface.co/datasets/softcatala/Tilde-MODEL-Catalan/blob/main/README.md

Expected results

README info should appear in the Dataset card page.

Actual results

Nothing is shown. However, labels are parsed and shown successfully.

julien-c commented 2 years ago

i suspect a markdown parsing error, @severo do you want to take a quick look at it when you have some time?

ritwikraha commented 2 years ago

Problem

The issue seems to coming from the front matter of the README

annotations_creators:
- no-annotation
language_creators:
- machine-generated
languages:
- 'ca'
- 'de'
licenses:
- cc-by-4.0
multilinguality:
- translation
pretty_name: Catalan-German aligned corpora to train NMT systems.
size_categories:
- "1M<n<10M"            
source_datasets:
- extended|tilde_model
task_categories:
- machine-translation
task_ids:
- machine-translation
---

Solution

The fix is to correctly style the README as explained here. I have also correctly parsed the font matter as shown below:

---
annotations_creators: []
language_creators: [machine-generated]
languages: ['ca', 'de']
licenses: []
multilinguality:
- multilingual
pretty_name: 'Catalan-German aligned corpora to train NMT systems.'
size_categories: 
- 1M<n<10M
source_datasets: ['extended|tilde_model']
task_categories: ['machine-translation']
task_ids: ['machine-translation']
---

You can find the README for a sample dataset here

davidcanovas commented 2 years ago

Thank you. It finally worked implementing your changes and leaving a white line between title and text in the description.