Update README.md

README.md

@@ -1,36 +1,55 @@
 ---
+
 language:
+
 - ca
+
 license: apache-2.0
+
 tags:
+
 - "catalan"
-- "qa"
+
+- "named entity recognition"
+
+- "ner"
+
+- "CaText"
+
+- "Catalan Textual Corpus"
+
 datasets:
-- "xquad-ca"
-- "viquiquad"  
+
+- "projecte-aina/ancora-ca-ner"
+
 metrics:
-- "f1"
-- "exact match"
+
+- f1
+
+model-index:
+- name: roberta-base-ca-cased-ner
+  results:
+  - task: 
+      type: token-classification 
+    dataset:
+      type:   projecte-aina/ancora-ca-ner
+      name: Ancora-ca-NER
+    metrics:
+      - name: F1
+        type: f1
+        value: 0.8813
+        
 widget:
-- text: "Quan va començar el Super3?"
-  context: "El Super3 o Club Super3 és un univers infantil català creat a partir d'un programa emès per Televisió de Catalunya des del 1991. Està format per un canal de televisió, la revista Súpers!, la Festa dels Súpers i un club que té un milió i mig de socis."
-  
-- text: "Quants eren els germans Marx?"
-  context: "Els germans Marx van ser un grup de còmics dels Estats Units que originàriament estava compost per cinc germans (entre parèntesis els noms artístics): Leonard (Chico), Adolph (Harpo), Julius (Groucho), Milton (Gummo) i Herbert (Zeppo)."
-  
-- text: "On van ser els Jocs Olímpics de 1992?"
-  context: "Els Jocs Olímpics d'estiu de 1992, oficialment Jocs Olímpics de la XXV Olimpíada, es van celebrar a la ciutat de Barcelona entre els dies 25 de juliol i 9 d'agost de 1992. Hi participaren 9.356 atletes (6.652 homes i 2.704 dones) de 169 comitès nacionals, que competiren en 32 esports i 286 especialitats."
-  
-- text: "Qui va dissenyar la Sagrada Família?"
-  context: "El Temple Expiatori de la Sagrada Família, conegut habitualment com la Sagrada Família, és una basílica catòlica situada a la ciutat de Barcelona. És un dels exemples més coneguts del modernisme català i un edifici únic al món, que ha esdevingut tot un símbol de la ciutat. Obra inacabada de l'arquitecte català Antoni Gaudí, és al barri de la Sagrada Família, al districte de l'Eixample de la ciutat."
-  
-- text: "Quin és el tercer volcà més gran de la Terra?"
-  context: "El Teide (o Pic del Teide) és un estratovolcà i muntanya de Tenerife, Illes Canàries (28.27 N, 16.6 O). Amb una altitud de 3718 m sobre el nivell del mar i amb aproximadament uns 7000 m sobre el llit marí adjacent, és la muntanya més alta d'Espanya, la muntanya més alta de totes les illes atlàntiques i el tercer volcà més gran de la Terra."
 
+- text: "Em dic Lluïsa i visc a Santa Maria del Camí." 
+
+- text: "L'Aina, la Berta i la Norma són molt amigues."
+
+- text: "El Martí llegeix el Cavall Fort."
 
 ---
 
-# Catalan BERTa (roberta-base-ca) finetuned for Question Answering.
+# Catalan BERTa (roberta-base-ca) finetuned for Named Entity Recognition.
 
 ## Table of Contents
 - [Model Description](#model-description)
@@ -49,11 +68,11 @@ widget:
 
 ## Model description
 
-The **roberta-base-ca-cased-qa** is a Question Answering (QA) model for the Catalan language fine-tuned from the roberta-base-ca model, a [RoBERTa](https://arxiv.org/abs/1907.11692) base model pre-trained on a medium-size corpus collected from publicly available corpora and crawlers.
+The **roberta-base-ca-cased-ner** is a Named Entity Recognition (NER) model for the Catalan language fine-tuned from the [roberta-base-ca](https://huggingface.co/projecte-aina/roberta-base-ca) model, a [RoBERTa](https://arxiv.org/abs/1907.11692) base model pre-trained on a medium-size corpus collected from publicly available corpora and crawlers (check the roberta-base-ca model card for more details).
 
 ## Intended Uses and Limitations
 
-**roberta-base-ca-cased-qa** model can be used for extractive question answering. The model is limited by its training dataset and may not generalize well for all use cases.
+**roberta-base-ca-cased-ner** model can be used to recognize Named Entities in the provided text. The model is limited by its training dataset and may not generalize well for all use cases.
 
 ## How to Use
 
@@ -61,19 +80,19 @@ Here is how to use this model:
 
 ```python
 from transformers import pipeline
+from pprint import pprint
 
-nlp = pipeline("question-answering", model="projecte-aina/roberta-base-ca-cased-qa")
-text = "Quan va començar el Super3?"
-context = "El Super3 o Club Super3 és un univers infantil català creat a partir d'un programa emès per Televisió de Catalunya des del 1991. Està format per un canal de televisió, la revista Súpers!, la Festa dels Súpers i un club que té un milió i mig de socis."
-  
-qa_results = nlp(text, context)
-print(qa_results)
+nlp = pipeline("ner", model="projecte-aina/roberta-base-ca-cased-ner")
+example = "Em dic Lluïsa i visc a Santa Maria del Camí."
+
+ner_results = nlp(example)
+pprint(ner_results)
 ```
 
 ## Training
 
 ### Training data
-We used the QA dataset in Catalan called [CatalanQA](https://huggingface.co/datasets/projecte-aina/catalanqa) for training and evaluation, and the [XQuAD-ca](https://huggingface.co/datasets/projecte-aina/xquad-ca) test set for evaluation.
+We used the NER dataset in Catalan called [AnCora-Ca-NER](https://huggingface.co/datasets/projecte-aina/ancora-ca-ner) for training and evaluation.
 
 ### Training Procedure
 The model was trained with a batch size of 16 and a learning rate of 5e-5 for 5 epochs. We then selected the best checkpoint using the downstream task metric in the corresponding development set and then evaluated it on the test set.
@@ -85,15 +104,15 @@ The model was trained with a batch size of 16 and a learning rate of 5e-5 for 5
 This model was finetuned maximizing F1 score.
 
 ### Evaluation results
-We evaluated the _roberta-base-ca-cased-qa_ on the CatalanQA and XQuAD-ca test sets against standard multilingual and monolingual baselines:
+We evaluated the _roberta-base-ca-cased-ner_ on the AnCora-Ca-NER test set against standard multilingual and monolingual baselines:
 
 
-| Model        | ViquiQuAD (F1/EM)  | XQuAD-ca (F1/EM) | 
-| ------------|:-------------:| -----:|
-| roberta-base-ca-cased-qa | **86.99/73.25** | **67.81/49.43**  |
-| mBERT       | 86.97/72.22 | 67.15/46.51 |
-| XLM-RoBERTa | 85.50/70.47 | 67.10/46.42 |
-| WikiBERT-ca | 85.45/70.75 | 65.21/36.60  |
+| Model        | Ancora-ca-ner (F1)| 
+| ------------|:-------------|
+| roberta-base-ca-cased-ner | **88.13** |
+| mBERT       | 86.38 |
+| XLM-RoBERTa | 87.66 | 
+| WikiBERT-ca | 77.66 |
 
 For more details, check the fine-tuning and evaluation scripts in the official [GitHub repository](https://github.com/projecte-aina/club).
 
@@ -102,6 +121,7 @@ For more details, check the fine-tuning and evaluation scripts in the official [
 [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
 ## Citation Information 
+
 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,
@@ -127,8 +147,3 @@ If you use any of these resources (datasets or models) in your work, please cite
 
 ### 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).
-
-
-## Contributions
-
-[N/A]