updated README

README.md

@@ -1,51 +1,41 @@
 ---
+YAML tags:
+annotations_creators:
+- expert-generated
+language_creators:
+- found
 languages:
-- ca
+- Catalan
+licenses:
+- cc-by-nc-nd-4.0
+multilinguality:
+- monolingual
+pretty_name: tecla
+size_categories:
+- unknown
+source_datasets: []
+task_categories:
+- text-classification
+task_ids:
+- multi-class-classification
 ---
-# TeCla (Text Classification) Catalan dataset
 
-## BibTeX  citation
+# TeCla (Text Classification) Catalan dataset
 
-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 (carlos.rodriguez1@bsc.es) and Carme Armentano-Oller (carme.armentano@bsc.es)
 
-https://doi.org/10.5281/zenodo.4627198
 
 
-## Introduction
+### Dataset Summary
 
 TeCla is a Catalan News corpus for thematic Text Classification tasks. It contains 153.265 articles classified under 30 different categories.
 
-The source data is crawled from the ACN (Catalan News Agency) site: [http://www.acn.cat], and used under CC-BY-NC-ND 4.0 licence. The dataset is released under the same licence, and is intended exclusively for training Machine Learning models.
-
-This dataset was developed by BSC TeMU as part of the AINA project, and intended as part of CLUB (Catalan Language Understanding Benchmark). 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 was developed by BSC TeMU as part of the AINA project, and intended as part of CLUB (Catalan Language Understanding Benchmark).
 
 ### Supported Tasks and Leaderboards
 
@@ -55,15 +45,6 @@ Text classification, Language Model
 
 CA- Catalan
 
-### Directory structure
-
-* **.gitattributes**
-* **README.md**
-* **dev.json** - json-formatted file with the dev split of the dataset
-* **tecla.py**
-* **test.json** - json-formatted file with the test split of the dataset
-* **train.json** - json-formatted file with the train split of the dataset
-
 ## Dataset Structure
 
 ### Data Instances
@@ -74,7 +55,7 @@ Three json files, one for each split.
 
 We used a simple model with the article text and associated labels, without further metadata.
 
-### Example:
+#### Example:
 
 <pre>
 {"version": "1.0",
@@ -93,88 +74,15 @@ We used a simple model with the article text and associated labels, without furt
 
 </pre>
 
-### Data Splits
-* train.json: 122587 article-label pairs
-* dev.json: 15339  article-label pairs
-* test.json: 15339  article-label pairs
-
-### Labels
+#### Labels
 
 'Societat', 'Política', 'Turisme', 'Salut', 'Economia', 'Successos', 'Partits', 'Educació', 'Policial', 'Medi ambient', 'Parlament', 'Empresa', 'Judicial', 'Unió Europea', 'Comerç', 'Cultura', 'Cinema', 'Govern', 'Lletres', 'Infraestructures', 'Música', 'Festa i cultura popular', 'Teatre', 'Mobilitat', 'Govern espanyol', 'Equipaments i patrimoni', 'Meteorologia', 'Treball', 'Trànsit', 'Món'
 
+### Data Splits
 
-### Labels in the dataset by frequency
-
-train.json: 122587 articles
-
-| Label | Num art |% art |
-|:-----------------------|--------------:|------: |
-| Societat | 24975 | 20.37% |
-| Política | 18344 | 14.96% |
-| Partits | 10056 | 8.2% |
-| Successos | 7874 | 6.42% |
-| Judicial | 5788 | 4.72% |
-| Policial | 5557 | 4.53% |
-| Salut | 5430 | 4.43% |
-| Economia | 5032 | 4.1% |
-| Parlament | 4176 | 3.41% |
-| Medi_ambient | 3027 | 2.47% |
-| Música | 2872 | 2.34% |
-| Educació | 2757 | 2.25% |
-| Empresa | 2698 | 2.2% |
-| Cultura | 2495 | 2.04% |
-| Unió_Europea | 2064 | 1.68% |
-| Govern | 2039 | 1.66% |
-| Infraestructures | 1740 | 1.42% |
-| Treball | 1655 | 1.35% |
-| Mobilitat | 1624 | 1.32% |
-| Cinema | 1560 | 1.27% |
-| Teatre | 1492 | 1.22% |
-| Turisme | 1232 | 1.01% |
-| Equipaments_i_patrimoni | 1229 | 1.0% |
-| Lletres | 1180 | 0.96% |
-| Meteorologia | 1080 | 0.88% |
-| Comerç | 984 | 0.8% |
-| Govern_espanyol | 983 | 0.8% |
-| Món | 893 | 0.73% |
-| Festa_i_cultura_popular | 888 | 0.72% |
-| Trànsit | 863 | 0.7% |
-
-dev.json and test.json: 153265 articles each split
-
-| Label | Num art |% art |
-|:----------------------- | --------------:| ------: |
-| Societat | 3122 | 20.35% |
-| Política | 2294 | 14.96% |
-| Partits | 1257 | 8.19% |
-| Successos | 985 | 6.42% |
-| Judicial | 724 | 4.72% |
-| Policial | 695 | 4.53% |
-| Salut | 679 | 4.43% |
-| Economia | 630 | 4.11% |
-| Parlament | 523 | 3.41% |
-| Medi_ambient | 379 | 2.47% |
-| Música | 359 | 2.34% |
-| Educació | 345 | 2.25% |
-| Empresa | 338 | 2.2% |
-| Cultura | 312 | 2.03% |
-| Unió_Europea | 258 | 1.68% |
-| Govern | 256 | 1.67% |
-| Infraestructures | 218 | 1.42% |
-| Treball | 208 | 1.36% |
-| Mobilitat | 204 | 1.33% |
-| Cinema | 195 | 1.27% |
-| Teatre | 187 | 1.22% |
-| Turisme | 154 | 1.0% |
-| Equipaments_i_patrimoni | 154 | 1.0% |
-| Lletres | 148 | 0.96% |
-| Meteorologia | 135 | 0.88% |
-| Govern_espanyol | 124 | 0.81% |
-| Comerç | 123 | 0.8% |
-| Festa_i_cultura_popular | 112 | 0.73% |
-| Món | 112 | 0.73% |
-| Trànsit | 109 | 0.71% |
-
+* train.json: 110203 article-label pairs
+* dev.json: 13786  article-label pairs
+* test.json: 13786  article-label pairs
 
 ## Dataset Creation
 
@@ -207,10 +115,6 @@ We used the "subsection" category as a classification label, after excluding ter
 
 Editorial staff classified the articles under the different thematic sections, and we extracted these from metadata.
 
-### Dataset Curators
-
-Casimiro Pio Carrino, Carlos Rodríguez and Carme Armentano, from BSC-CNS
-
 ### Personal and Sensitive Information
 
 No personal or sensitive information included.
@@ -229,12 +133,48 @@ No personal or sensitive information included.
 
 [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 a <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",
+}
+
 
-## Contact
+```
 
-Carlos Rodríguez-Penagos (carlos.rodriguez1@bsc.es) and Carme Armentano-Oller (carme.armentano@bsc.es)
+[DOI](https://doi.org/10.5281/zenodo.4529183)
 
-## License
+### Funding
 
-<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 a <a rel="license" href="https://creativecommons.org/licenses/by-nc-nd/4.0/">Attribution-NonCommercial-NoDerivatives 4.0 International License</a>.
+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/).