Update dataset card

README.md

@@ -20,19 +20,43 @@ task_ids:
 - extractive-qa
 ---
 
-# VilaQuAD, An extractive QA dataset for catalan, from Vilaweb newswire text
-
+# Dataset Card for VilaQuAD
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
 
 ## Dataset Description
 
+- **Homepage:** https://doi.org/10.5281/zenodo.4562337
 - **Paper:** [Are Multilingual Models the Best Choice for Moderately Under-resourced Languages? A Comprehensive Assessment for Catalan](https://arxiv.org/abs/2107.07903)
-
-- **Point of Contact:** Carlos Rodríguez-Penagos (carlos.rodriguez1@bsc.es) and Carme Armentano-Oller (carme.armentano@bsc.es)
-
-
+- **Point of Contact:** [Carlos Rodríguez-Penagos](mailto:carlos.rodriguez1@bsc.es) and [Carme Armentano-Oller](mailto:carme.armentano@bsc.es)
 
 ### Dataset Summary
 
+VilaQuAD, An extractive QA dataset for catalan, from Vilaweb newswire text.
+
 This dataset contains 2095 of Catalan language news articles along with 1 to 5 questions referring to each fragment (or context).
 
 VilaQuad articles are extracted from the daily Vilaweb (www.vilaweb.cat) and used under [CC-by-nc-sa-nd](https://creativecommons.org/licenses/by-nc-nd/3.0/deed.ca) licence. 
@@ -41,59 +65,49 @@ This dataset can be used to build extractive-QA and Language Models.
 
 ### Supported Tasks and Leaderboards
 
-Extractive-QA, Language Model
+Extractive-QA, Language Model.
 
 ### Languages
 
-CA - Catalan
+Catalan (`ca`).
 
 ## Dataset Structure
 
 ### Data Instances
 
-<pre>
-
+```
 {
-  "data": [
+  'id': 'P_556_C_556_Q1',
+  'title': "El Macba posa en qüestió l'eufòria amnèsica dels anys vuitanta a l'estat espanyol",
+  'context': "El Macba ha obert una nova exposició, 'Gelatina dura. Històries escamotejades dels 80', dedicada a revisar el discurs hegemònic que es va instaurar en aquella dècada a l'estat espanyol, concretament des del començament de la transició, el 1977, fins a la fita de Barcelona 92. És una mirada en clau espanyola, però també centralista, perquè més enllà dels esdeveniments ocorreguts a Catalunya i els artistes que els van combatre, pràcticament només s'hi mostren fets polítics i culturals generats des de Madrid. No es parla del País Basc, per exemple. Però, dit això, l'exposició revisa aquesta dècada de la història recent tot qüestionant un triomfalisme homogeneïtzador, que ja se sap que va arrasar una gran quantitat de sectors crítics i radicals de l'àmbit social, polític i cultural. Com diu la comissària, Teresa Grandas, de l'equip del Macba: 'El relat oficial dels anys vuitanta a l'estat espanyol va prioritzar la necessitat per damunt de la raó i va consolidar una mirada que privilegiava el futur abans que l'anàlisi del passat recent, obviant qualsevol consideració crítica respecte de la filiació amb el poder franquista.",
+  'question': 'Com es diu la nova exposició que ha obert el Macba?',
+  'answers': [
     {
-      "title": "Com celebrar el Cap d'Any 2020? Deu propostes per a acomiadar-se del 2019",
-      "paragraphs": [
-        {
-          "context": "Hi ha moltes propostes per a acomiadar-se d'aquest 2019. Els uns es queden a casa, els altres volen anar lluny o sortir al teatre. També s'organitzen festes o festivals a l'engròs, fins i tot hi ha propostes diürnes. Tot és possible per Cap d'Any. Encara no sabeu com celebrar l'entrada el 2020? Us oferim una llista amb deu propostes variades arreu dels Països Catalans: Festivern El Festivern enguany celebra quinze anys.",
-          "qas": [
-            {
-              "answers": [
-                {
-                  "text": "festes o festivals",
-                  "answer_start": 150
-                }
-              ],
-              "id": "P_23_C_23_Q2",
-              "question": "Què s'organitza a l'engròs per acomiadar el 2019?"
-            },
-            ...
-          ]
-        }
-      ]
-    }, 
-    ...
-   ]
-} 
-
-</pre>
+      'text': "'Gelatina dura. Històries escamotejades dels 80'",
+      'answer_start': 38
+    }
+  ]
+}
+```
+
 ### Data Fields
 
 Follows [Rajpurkar, Pranav et al., 2016](http://arxiv.org/abs/1606.05250) for squad v1 datasets.
 
+- `id` (str): Unique ID assigned to the question.
+- `title` (str): Title of the Wikipedia article.
+- `context` (str): Wikipedia section text.
+- `question` (str): Question.
+- `answers` (list): List of answers to the question, each containing:
+  - `text` (str): Span text answering to the question.
+  - `answer_start` Starting offset of the span text answering to the question.
+
 ### Data Splits
 
 - train.json: 1295 contexts, 3882 questions
-
 - dev.json: 400 contexts, 1200 questions
-
 - test.json: 400 contexts, 1200 questions
 
-
 ## Dataset Creation
 
 ### Methodology
@@ -156,10 +170,7 @@ This work is licensed under a <a rel="license" href="https://creativecommons.org
 
 ### Citation Information
 
-
-
 ```
-
 @inproceedings{armengol-estape-etal-2021-multilingual,
     title = "Are Multilingual Models the Best Choice for Moderately Under-resourced Languages? {A} Comprehensive Assessment for {C}atalan",
     author = "Armengol-Estap{\'e}, Jordi  and
@@ -179,7 +190,6 @@ This work is licensed under a <a rel="license" href="https://creativecommons.org
     doi = "10.18653/v1/2021.findings-acl.437",
     pages = "4933--4946",
 }
-
 ```
 
 [DOI](https://doi.org/10.5281/zenodo.4562337)