updated readme

readme.md

@@ -0,0 +1,165 @@
+---
+YAML tags:
+- copy-paste the tags obtained with the online tagging app: https://huggingface.co/spaces/huggingface/datasets-tagging
+---
+
+# Dataset Card Creation Guide
+
+
+## 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)
+
+- **Point of Contact:** Carlos Rodríguez-Penagos (carlos.rodriguez1@bsc.es) and Carme Armentano-Oller (carme.armentano@bsc.es)
+
+
+### Dataset Summary
+
+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
+
+Textual eintailment, Text classification, Language Model
+
+### Languages
+
+CA - Catalan
+
+## Dataset Structure
+
+### Data Instances
+
+Three JSON files, one for each split.
+
+### Example:
+
+<pre>
+    
+    {
+        "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>
+
+### Data Fields
+
+- premise: text
+- hypothesis: text related to the premise
+- label: relation between premise and hypothesis:
+    * 0: entailment
+    * 1: neutral
+    * 2: contradiction
+    
+### Data Splits
+
+* dev.json: 2116 examples
+* test.json: 2117 examples
+* train.json: 16930 examples
+
+## Dataset Creation
+
+### Curation Rationale
+
+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
+
+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. 
+
+#### Who are the annotators?
+
+Annotators are a team of native language collaborators from two intependent companies.
+
+### 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.
+
+### 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
+
+
+
+```
+
+@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",
+}
+
+
+```
+
+[DOI](https://doi.org/10.5281/zenodo.4529183)
+
+### 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/).