updated README

README.md

@@ -1,128 +1,182 @@
 ---
-languages:
-- ca
----
-# TECA: Textual Entailment Catalan dataset
-
-## BibTeX  citation
+YAML tags:
 
-If you use any of these resources (datasets or models) in your work, please cite our latest paper:
+annotations_creators:
+- expert-generated
+language_creators:
+- found
+languages:
+- Catalan
+licenses:
+- cc-by-nc-nd-4.0
+multilinguality:
+- monolingual
+pretty_name: teca
+size_categories:
+- unknown
+source_datasets: []
+task_categories:
+- text-classification
 
-```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",
-}
-```
+---
 
+# TECA
 
-## Digital Object Identifier (DOI) and access to dataset files
 
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4761458.svg)](https://doi.org/10.5281/zenodo.4761458)
+## 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)
 
-## Introduction
+- **Point of Contact:** Carlos Rodríguez-Penagos (carlos.rodriguez1@bsc.es) and Carme Armentano-Oller (carme.armentano@bsc.es)
 
-TECA consists of two subsets of textual entailment in Catalan, *catalan_TE1* and *vilaweb_TE*, which contain 14997 and 6166 pairs of premises and hypotheses, annotated according to the inference relation they have (implication, contradiction or neutral).
 
-This dataset was developed by BSC TeMU as part of the AINA project and intended as part of the Catalan Language Understanding Benchmark (CLUB). It is part of the Catalan Language Understanding Benchmark (CLUB) as presented in: 
+### Dataset Summary
 
-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).
+TECA is a dataset of textual entailment in Catalan, which contains 21 163 pairs of premises and hypotheses, annotated according to the inference relation they have (implication, contradiction or neutral).
 
+This dataset was developed by BSC TeMU as part of the AINA project and intended as part of the Catalan Language Understanding Benchmark (CLUB).
 
 ### Supported Tasks and Leaderboards
 
-Text classification, Language Model
-
-###  Languages
+Textual eintailment, Text classification, Language Model
 
-CA-  Catalan
+### Languages
 
-###  Directory structure
-
-* **.gitattributes**
-* **README.md**
-* **dev.json** - json-formatted file with the dev split of the dataset
-* **teca.py** - data loader script
-* **test.json** - json-formatted file with the test split of the dataset
-* **train.json** - json-formatted file with the train split of the dataset
+CA - Catalan
 
 ## Dataset Structure
 
 ### Data Instances
 
-Two JSON files, one for each subset.
+Three JSON files, one for each split.
 
 ### Example:
 
 <pre>
-{
-"id": 6940,
-"premise": "Podriem posar uns bons filtres a les xemeneies de les quimiques per tal de que poguin seguint havent"hypothesis": "Caldria eliminar tots els filtres de les xemeneies de les qu\u00edmiques.",
-"label": "2"
-}
+    
+    {
+        "id": 3247,
+        "premise": "L'ONU adopta a Marràqueix un pacte no vinculant per les migracions",
+        "hypothesis": "S'acorden unes recomanacions per les persones migrades a Marràqueix",
+        "label": "0"
+    },
+    {
+        "id": 2825,
+        "premise": "L'ONU adopta a Marràqueix un pacte no vinculant per les migracions",
+        "hypothesis": "Les persones migrades seran acollides a Marràqueix",
+        "label": "1"
+    },
+    {
+        "id": 2431,
+        "premise": "L'ONU adopta a Marràqueix un pacte no vinculant per les migracions",
+        "hypothesis": "L'acord impulsat per l'ONU lluny de tancar-se",
+        "label": "2"
+    },
 </pre>
 
-### Number of sentence pairs
-* catalan_TE1: 14,997
-* vilaweb_TE: 6,166 
+### Data Fields
 
-## Dataset Creation
-
-### Methodology
+- premise: text
+- hypothesis: text related to the premise
+- label: relation between premise and hypothesis:
+    * 0: entailment
+    * 1: neutral
+    * 2: contradiction
+    
+### Data Splits
 
-catalan_TE1: 12000 sentences were chosen randomly from the BSC Catalan Textual Corpus, and filtered by different criteria, such as length and
-stand-alone intelligibility. From 6000 text sentences, we commissioned 3 hypotheses (one for each entailment category) to be written by a team of
-annotators. 
+* dev.json: 2116 examples
+* test.json: 2117 examples
+* train.json: 16930 examples
 
-vilaweb_TE: We randomly selected 6200 headers from the Catalan news site Vilaweb and filtered them to obtain 2100 text sentences. For each
-text, 3 hypotheses were likewise commissioned. 
+## Dataset Creation
 
 ### Curation Rationale
 
-In both sub-datasets, some sentence pairs were excluded because of inconsistencies. 
+Some sentence pairs were excluded because of inconsistencies. 
 
 ### Source Data
 
+Source sentences are extracted from the [Catalan Textual Corpus](https://doi.org/10.5281/zenodo.4519349) and from [Vilaweb](https://www.vilaweb.cat) newswire.
+
 #### Initial Data Collection and Normalization
 
-Source sentences are extracted from the [Catalan Textual Corpus](https://doi.org/10.5281/zenodo.4519349), and from Vilaweb newswire.
+12000 sentences from the BSC Catalan Textual Corpus, together with 6200 headers from the Catalan news site Vilaweb, were chosen randomly. We filtered them by different criteria, such as length and stand-alone intelligibility. For each selected text, we commissioned 3 hypotheses (one for each entailment category) to be written by a team of native annotators. 
+
+#### Who are the source language producers?
+
+The Catalan Textual Corpus corpus consists of several corpora gathered from web crawling and public corpora. More information [here](https://doi.org/10.5281/zenodo.4519349).
+[Vilaweb](https://www.vilaweb.cat) is a Catalan newswire.
+
+### Annotations
+
+#### Annotation process
+
+We commissioned 3 hypotheses (one for each entailment category) to be written by a team of annotators. 
 
-## Annotations
+#### Who are the annotators?
 
-#### Inter-annotator agreement:
+Annotators are a team of native language collaborators from two intependent companies.
 
-From 600 randomly selected samples, the inter-annotator agreement was 83,57%.
+### Personal and Sensitive Information
+
+No personal or sensitive information included.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
 
 ### Dataset Curators
 
 Casimiro Pio Carrino, Carlos Rodríguez and Carme Armentano, from BSC-CNS.
 
-### Personal and Sensitive Information
+### Licensing Information
+
+This work is licensed under an <a rel="license" href="https://creativecommons.org/licenses/by-nc-nd/4.0/">Attribution-NonCommercial-NoDerivatives 4.0 International License</a>.
+
+### Citation Information
 
-No personal or sensitive information is included.
 
-## Contact
 
-- Carlos Rodríguez-Penagos (carlos.rodriguez1@bsc.es)
-- Carme Armentano-Oller (carme.armentano@bsc.es)
+```
+
+@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.4529183)
 
-<a rel="license" href="https://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Attribution-NonCommercial-NoDerivatives 4.0 International License" style="border-width:0" src="http://d2klr1ixr44jla.cloudfront.net/306/125/0.5-0.5/assets/images/55132bfeb13b7b027c000041.png" width="100"/></a><br />This work is licensed under an <a rel="license" href="https://creativecommons.org/licenses/by-nc-nd/4.0/">Attribution-NonCommercial-NoDerivatives 4.0 International License</a>.
+### Funding
 
+This work was funded by the [Catalan Ministry of the Vice-presidency, Digital Policies and Territory](https://politiquesdigitals.gencat.cat/en/inici/index.html) within the framework of the [Aina project](https://politiquesdigitals.gencat.cat/ca/tic/aina-el-projecte-per-garantir-el-catala-en-lera-digital/).