Update README.md

README.md

@@ -1,3 +1,155 @@
 ---
+language: ca
 license: apache-2.0
+tags:
+- "catalan"
+- "masked-lm"
+- "distilroberta"
+- "CaText"
+- "Catalan Textual Corpus"
+widget:
+- text: "El Català és una llengua molt <mask>."
+- text: "Salvador Dalí va viure a <mask>."
+- text: "La Costa Brava té les millors <mask> d'Espanya."
+- text: "El cacaolat és un batut de <mask>."
+- text: "<mask> és la capital de la Garrotxa."
+- text: "Vaig al <mask> a buscar bolets."
+- text: "Antoni Gaudí vas ser un <mask> molt important per la ciutat."
+- text: "Catalunya és una referència en <mask> a nivell europeu."
 ---
+
+# [TODO: MODEL_NAME]
+
+## Table of Contents
+<details>
+<summary>Click to expand</summary>
+
+- [Model description](#model-description)
+- [Intended uses and limitations](#intended-use)
+- [How to use](#how-to-use)
+- [Limitations and bias](#limitations-and-bias)
+- [Training](#training)
+- [Evaluation](#evaluation)
+- [Additional information](#additional-information)
+  - [Author](#author)
+  - [Contact information](#contact-information)
+  - [Copyright](#copyright)
+  - [Licensing information](#licensing-information)
+  - [Funding](#funding)
+  - [Citing information](#citing-information)
+  - [Disclaimer](#disclaimer)
+
+</details>
+
+## Overview
+- **Architecture:** [TODO: roberta-base/roberta-large/bart...]
+- **Language:** [TODO: Catalan/Spanish...]
+- **Task:** [TODO: Text Classification / Extractive QA...]
+- **Data:** [TODO: BNE/Tecla/Teca/Pharmaconer...]
+
+
+## Model description
+
+[TODO: Brief description of the model]
+
+
+## Intended uses and limitations
+
+[TODO: Mention the tasks it can perform]
+
+
+## How to use
+
+```python
+from transformers import AutoModel, AutoTokenizer, pipeline
+from datasets import load_dataset
+[TODO: Add minimal code here]
+```
+
+## Limitations and bias
+
+At the time of submission, no measures have been taken to estimate the bias embedded in the model. However, we are well aware that our models may be biased since the corpora have been collected using crawling techniques on multiple web sources. We intend to conduct research in these areas in the future, and if completed, this model card will be updated. 
+
+## Training
+
+### Training data
+
+The training corpus consists of several corpora gathered from web crawling and public corpora.
+
+| Corpus                  | Size in GB |
+|-------------------------|------------|
+| Catalan Crawling        | 13.00      |
+| Wikipedia               | 1.10       |
+| DOGC                    | 0.78       |
+| Catalan Open Subtitles  | 0.02       |
+| Catalan Oscar           | 4.00       |
+| CaWaC                   | 3.60       |
+| Cat. General Crawling   | 2.50       |
+| Cat. Goverment Crawling | 0.24       |
+| ACN                     | 0.42       |
+| Padicat                 | 0.63       |
+| RacoCatalá              | 8.10       |
+| Nació Digital           | 0.42       |
+| Vilaweb                 | 0.06       |
+| Tweets                  | 0.02       |
+
+### Training procedure
+
+[TODO]
+
+## Evaluation
+
+### Variable and metrics
+
+[TODO]
+
+### Evaluation results
+
+| Task        | NER (F1)      | POS (F1)   | STS-ca (Comb)   | TeCla (Acc.) | TEca (Acc.) | VilaQuAD (F1/EM)| ViquiQuAD (F1/EM) | CatalanQA (F1/EM) | XQuAD-ca <sup>1</sup> (F1/EM) | 
+| ------------|:-------------:| -----:|:------|:------|:-------|:------|:----|:----|:----|
+| RoBERTa-large-ca-v2        | **89.82** | **99.02** | **83.41** | **75.46** | **83.61** | **89.34/75.50** | **89.20**/75.77 | **90.72/79.06** | **73.79**/55.34 |
+| RoBERTa-base-ca-v2      | 89.29 | 98.96 | 79.07 | 74.26 | 83.14 | 87.74/72.58 | 88.72/**75.91** | 89.50/76.63 | 73.64/**55.42** |
+| DistilRoBERTa-base-ca-v2| xx.xx | xx.xx | xx.xx | xx.xx | xx.xx | xx.xx/xx.xx | xx.xx/xx.xx | xx.xx/xx.xx | xx.xx/xx.xx |
+
+<sup>1</sup> : Trained on CatalanQA, tested on XQuAD-ca.
+
+
+## Additional Information
+
+### Authors 
+
+Text Mining Unit (TeMU) at the Barcelona Supercomputing Center (bsc-temu@bsc.es).
+
+### Contact information
+
+For further information, send an email to aina@bsc.es.
+
+## Copyright
+
+Copyright by the Text Mining Unit at Barcelona Supercomputing Center.
+
+### Licensing Information
+
+This work is licensed under a [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+### Funding
+
+This work was funded by the [Departament de la Vicepresidència i de Polítiques Digitals i Territori de la Generalitat de Catalunya](https://politiquesdigitals.gencat.cat/ca/inici/index.html#googtrans(ca|en) within the framework of [Projecte AINA](https://politiquesdigitals.gencat.cat/ca/economia/catalonia-ai/aina).
+
+### Citation Information
+
+```bibtex
+[TODO: add bibtext citation here]
+```
+
+### Disclaimer
+
+<details>
+<summary>Click to expand</summary>
+
+The models published in this repository are intended for a generalist purpose and are available to third parties. These models may have bias and/or any other undesirable distortions.
+
+When third parties, deploy or provide systems and/or services to other parties using any of these models (or using systems based on these models) or become users of the models, they should note that it is their responsibility to mitigate the risks arising from their use and, in any event, to comply with applicable regulations, including regulations regarding the use of Artificial Intelligence.
+
+In no event shall the owner and creator of the models (BSC – Barcelona Supercomputing Center) be liable for any results arising from the use made by third parties of these models.
+</details>