Update dataset card

README.md

@@ -20,19 +20,43 @@ task_ids:
 - extractive-qa
 ---
 
-# ViquiQuAD, An extractive QA dataset for catalan, from the Wikipedia
-
+# Dataset Card for ViquiQuAD
+
+## 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://zenodo.org/record/4562345#.YK41aqGxWUk
 - **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
 
+ViquiQuAD, An extractive QA dataset for catalan, from the Wikipedia.
+
 This dataset contains 3111 contexts extracted from a set of 597 high quality original (no translations) articles in the Catalan Wikipedia "Viquipèdia" (ca.wikipedia.org), and 1 to 5 questions with their answer for each fragment.
 
 Viquipedia articles are used under [CC-by-sa] (https://creativecommons.org/licenses/by-sa/3.0/legalcode) licence. 
@@ -45,45 +69,37 @@ Extractive-QA, Language Model
 
 ### Languages
 
-CA - Catalan
+Catalan (`ca`).
 
 ## Dataset Structure
 
 ### Data Instances
 
-<pre>
+```
 {
-  "data": [
-    {
-      "title": "Frederick W. Mote",
-      "paragraphs": [
-        {
-          "context": "L'historiador Frederick W. Mote va escriure que l'ús del terme \\\\\\\\\\\\\\\\"classes socials\\\\\\\\\\\\\\\\" per a aquest sistema era enganyós i que la posició de les persones dins del sistema de quatre classes no era una indicació del seu poder social i riquesa reals, sinó que només implicava \\\\\\\\\\\\\\\\"graus de privilegi\\\\\\\\\\\\\\\\" als quals tenien dret institucionalment i legalment, de manera que la posició d'una persona dins de les classes no era una garantia de la seva posició, ja que hi havia xinesos rics i amb bona reputació social, però alhora hi havia menys mongols i semu rics que mongols i semu que vivien en la pobresa i eren maltractats.",
-          "qas": [
-            {
-              "answers": [
-                {
-                  "text": "Frederick W. Mote",
-                  "answer_start": 14
-                }
-              ],
-              "id": "5728848cff5b5019007da298",
-              "question": "Qui creia que el sistema de classes socials de Yuan no s’hauria d’anomenar classes socials?"
-            },
-            ...
-          ]
-        }
-      ]
-    }, 
-    ...
-   ]
-} 
-
-</pre>
+  'id': 'P_66_C_391_Q1',
+  'title': 'Xavier Miserachs i Ribalta',
+  'context': "En aquesta època es va consolidar el concepte modern del reportatge fotogràfic, diferenciat del fotoperiodisme[n. 2] i de la fotografia documental,[n. 3] pel que fa a l'abast i el concepte. El reportatge fotogràfic implica més la idea de relat: un treball que vol més dedicació de temps, un esforç d'interpretació d'una situació i que culmina en un conjunt d'imatges. Això implica, d'una banda, la reivindicació del fotògraf per opinar, fet que li atorgarà estatus d'autor; l'autor proposa, doncs, una interpretació pròpia de la realitat. D'altra banda, el consens que s'estableix entre la majoria de fotògrafs és que el vehicle natural de la imatge fotogràfica és la pàgina impresa. Això suposà que revistes com Life, Paris-Match, Stern o Época assolissin la màxima esplendor en aquest període.",
+  'question': 'De què es diferenciava el reportatge fotogràfic?',
+  'answers': [{
+    'text': 'del fotoperiodisme[n. 2] i de la fotografia documental',
+    'answer_start': 92
+  }]
+}
+```
+
 ### 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: 11259 examples
@@ -145,7 +161,7 @@ No personal or sensitive information included.
 
 ### Dataset Curators
 
-Carlos Rodríguez-Penagos (carlos.rodriguez1@bsc.es) and Carme Armentano-Oller (carme.armentano@bsc.es)
+Carlos Rodríguez-Penagos (carlos.rodriguez1@bsc.es) and Carme Armentano-Oller (carme.armentano@bsc.es).
 
 ### Licensing Information
 
@@ -153,10 +169,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
@@ -176,7 +189,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.4562344)