Update README.md

README.md

@@ -1,50 +1,42 @@
 ---
+annotations_creators:
+- expert-generated
+language_creators:
+- found
 languages:
-- ca
+- catalan
+licenses:
+- cc-by-sa-4.0
+multilinguality:
+- monolingual
+pretty_name: vilaquad
+size_categories:
+- unknown
+source_datasets: []
+task_categories:
+- question-answering
+task_ids:
+- extractive-qa
 ---
+
 # ViquiQuAD, An extractive QA dataset for catalan, from the Wikipedia
 
-## BibTeX  citation
 
-If you use any of these resources (datasets or models) in your work, please cite our latest paper:
-
-```bibtex
-@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
-      Carrino, Casimiro Pio  and
-      Rodriguez-Penagos, Carlos  and
-      de Gibert Bonet, Ona  and
-      Armentano-Oller, Carme  and
-      Gonzalez-Agirre, Aitor  and
-      Melero, Maite  and
-      Villegas, Marta",
-    booktitle = "Findings of the Association for Computational Linguistics: ACL-IJCNLP 2021",
-    month = aug,
-    year = "2021",
-    address = "Online",
-    publisher = "Association for Computational Linguistics",
-    url = "https://aclanthology.org/2021.findings-acl.437",
-    doi = "10.18653/v1/2021.findings-acl.437",
-    pages = "4933--4946",
-}
-```
+## Dataset Description
 
+- **Paper:** [Are Multilingual Models the Best Choice for Moderately Under-resourced Languages? A Comprehensive Assessment for Catalan](https://arxiv.org/abs/2107.07903)
 
-# Digital Object Identifier (DOI) and access to dataset files
+- **Point of Contact:** Carlos Rodríguez-Penagos ([email protected]) and Carme Armentano-Oller ([email protected])
 
-https://doi.org/10.5281/zenodo.4562345
 
 
-## Introduction
+### Dataset Summary
 
 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. 
 
-This dataset can be used to fine-tune and evaluate extractive-QA and Language Models. It is part of the Catalan Language Understanding Benchmark (CLUB) as presented in: 
-
-Armengol-Estapé J., Carrino CP., Rodriguez-Penagos C., de Gibert Bonet O., Armentano-Oller C., Gonzalez-Agirre A., Melero M. and Villegas M.,Are Multilingual Models the Best Choice for Moderately Under-resourced Languages? A Comprehensive Assessment for Catalan". Findings of ACL 2021 (ACL-IJCNLP 2021).
+This dataset can be used to fine-tune and evaluate extractive-QA and Language Models. It is part of the Catalan Language Understanding Benchmark (CLUB).
 
 ### Supported Tasks and Leaderboards
 
@@ -52,27 +44,12 @@ Extractive-QA, Language Model
 
 ### Languages
 
-CA- Catalan
-
-### Directory structure
-
-* README
-* dev.json
-* test.json
-* train.json
-* viquiquad.py
+CA - Catalan
 
 ## Dataset Structure
 
 ### Data Instances
 
-json files
-
-### Data Fields
-
-Follows ((Rajpurkar, Pranav et al., 2016) for squad v1 datasets. (see below for full reference)
-
-### Example:
 <pre>
 {
   "data": [
@@ -102,56 +79,16 @@ Follows ((Rajpurkar, Pranav et al., 2016) for squad v1 datasets. (see below for
 } 
 
 </pre>
+### Data Fields
 
-### Data Splits
-
-train.development,test
-
-## Content analysis
-
-### Number of articles, paragraphs and questions
-
-* Number of articles: 597
-* Number of contexts: 3111
-* Number of questions: 15153
-* Questions/context: 4.87
-* Number of sentences in contexts: 15100
-* Sentences/context: 4.85
-
-### Number of tokens
-
-* tokens in context: 469335
-* tokens/context 150.86
-* tokens in questions: 145249
-* tokens/questions: 9.58
-* tokens in answers: 63246
-* tokens/answers: 4.17
-
-### Lexical variation
-
-After filtering (tokenization, stopwords, punctuation, case), 83,88% of the words in the question can be found in the Context
-
-### Question type 
-
-| Question | Count | % |
-|--------|-----|------|
-| què |  4220 | 27.85 % |
-| qui |  2239 | 14.78 % |
-| com |  1964 | 12.96 % |
-| quan |  1133 | 7.48 % |
-| on |  1580 | 10.43 % |
-| quant |  925 | 6.1 % |
-| quin |  3399 | 22.43 % |
-| no question mark | 21 | 0.14 % |
+Follows [Rajpurkar, Pranav et al., 2016](http://arxiv.org/abs/1606.05250) for squad v1 datasets.
 
-### Question-answer relationships
+### Data Splits
 
-From 100 randomly selected samples:
+- train
+- developement
+- test
 
-* Lexical variation: 33.0%
-* World knowledge: 16.0%
-* Syntactic variation: 35.0%
-* Multiple sentence: 17.0%
 
 ## Dataset Creation
 
@@ -161,7 +98,7 @@ From a set of high quality, non-translation, articles in the Catalan Wikipedia (
 
 ### Curation Rationale
 
-For compatibility with similar datasets in other languages, we followed as close as possible existing curation guidelines. 
+For compatibility with similar datasets in other languages, we followed as close as possible existing curation guidelines.
 
 ### Source Data
 
@@ -169,7 +106,7 @@ For compatibility with similar datasets in other languages, we followed as close
 
 #### Initial Data Collection and Normalization
 
-The source data are scraped articles from the Catalan wikipedia site (https://ca.wikipedia.org). 
+The source data are scraped articles from the Catalan wikipedia site (https://ca.wikipedia.org).
 
 #### Who are the source language producers?
 
@@ -183,11 +120,7 @@ We commissioned the creation of 1 to 5 questions for each context, following an
 
 #### Who are the annotators?
 
-Native language speakers.
-
-### Dataset Curators
-
-Carlos Rodríguez and Carme Armentano, from BSC-CNS
+Annotation was commissioned to an specialized company that hired a team of native language speakers.
 
 ### Personal and Sensitive Information
 
@@ -207,12 +140,43 @@ No personal or sensitive information included.
 
 [More Information Needed]
 
+## Additional Information
 
-## Contact
+### Dataset Curators
 
 Carlos Rodríguez-Penagos ([email protected]) and Carme Armentano-Oller ([email protected])
 
+### Licensing Information
+
+This work is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Attribution-ShareAlike 4.0 International License</a>.
+
+### 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
+      Carrino, Casimiro Pio  and
+      Rodriguez-Penagos, Carlos  and
+      de Gibert Bonet, Ona  and
+      Armentano-Oller, Carme  and
+      Gonzalez-Agirre, Aitor  and
+      Melero, Maite  and
+      Villegas, Marta",
+    booktitle = "Findings of the Association for Computational Linguistics: ACL-IJCNLP 2021",
+    month = aug,
+    year = "2021",
+    address = "Online",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2021.findings-acl.437",
+    doi = "10.18653/v1/2021.findings-acl.437",
+    pages = "4933--4946",
+}
+
+```
 
-## License
+[DOI](https://doi.org/10.5281/zenodo.4562344)
 
-<a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/"><img alt="Attribution-ShareAlike 4.0 International License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Attribution-ShareAlike 4.0 International License</a>.