Update README.md

README.md

@@ -1,38 +1,88 @@
 ---
 datasets:
 - squad_it
+metrics:
+- squad
 language:
 - it
 license: apache-2.0
 tags:
-  - italian
-  - squad_it
-  - question-answering
+- italian
+- squad_it
+- question-answering
 widget:
-- text: "La foresta pluviale amazzonica è diventata per lo più una foresta interna intorno a quale evento globale?"
-  context: "In seguito all' evento di estinzione del Cretaceo-Paleogene, l' estinzione dei dinosauri e il clima umido possono aver permesso alla foresta pluviale tropicale di diffondersi in tutto il continente. Dal 66-34 Mya, la foresta pluviale si estendeva fino a sud fino a 45°. Le fluttuazioni climatiche degli ultimi 34 milioni di anni hanno permesso alle regioni della savana di espandersi fino ai tropici. Durante l' Oligocene, ad esempio, la foresta pluviale ha attraversato una banda relativamente stretta. Si espandeva di nuovo durante il Miocene medio, poi si ritrasse ad una formazione prevalentemente interna all' ultimo massimo glaciale. Tuttavia, la foresta pluviale è riuscita ancora a prosperare durante questi periodi glaciali, consentendo la sopravvivenza e l' evoluzione di un' ampia varietà di specie." 
-- text: "Il Regno Unito e la Francia non hanno avuto interruzioni dell' approvvigionamento petrolifero in quanto non hanno consentito a quale paese di utilizzare il loro aeroporto?"
-  context: "L' embargo non era uniforme in tutta Europa. Dei nove membri della Comunità Economica Europea (CEE), i Paesi Bassi hanno dovuto affrontare un embargo totale, il Regno Unito e la Francia hanno ricevuto forniture quasi ininterrotte (poichè si sono rifiutati di consentire all' America di utilizzare i loro aerodromi e le armi e forniture embargo sia agli arabi che agli israeliani), mentre gli altri sei hanno dovuto affrontare tagli parziali. Il Regno Unito era tradizionalmente un alleato di Israele, e il governo di Harold Wilson ha sostenuto gli israeliani durante la guerra dei sei giorni. Il suo successore, Ted Heath, ribaltò questa politica nel 1970, chiedendo a Israele di ritirarsi ai suoi confini prima del 1967."
-- context: "Nel 1962, il grafico Paul Rand ridisegna il logo ABC nella sua forma più conosciuta (e attuale) con le lettere minuscole 'abc' racchiuse in un unico cerchio nero. Il nuovo logo esordisce in onda per le promozioni di ABC all' inizio della stagione 1963-64. Le lettere ricordano fortemente il carattere tipografico Bauhaus disegnato da Herbert Bayer negli anni Venti, ma condividono anche similitudini con diversi altri caratteri, come ITC Avant Garde e Horatio, e lo Chalet più simile. La semplicità del logo ha reso più facile la riprogettazione e la duplicazione, il che ha conferito un beneficio per ABC (soprattutto prima dell' avvento della computer grafica)."
-  text: "Di quale carattere tipografico ricordano le lettere dell' iconico logo ABC?"
-- context: "La fotorespirazione può verificarsi quando la concentrazione di ossigeno è troppo elevata. Rubisco non è in grado di distinguere molto bene tra ossigeno e anidride carbonica, quindi può accidentalmente aggiungere O2 invece di CO2 a RuBP. Questo processo riduce l' efficienza della fotosintesi: consuma ATP e ossigeno, rilascia CO2 e non produce zucchero. Può sprecare fino alla metà del carbonio fissato dal ciclo di Calvin. Diversi meccanismi si sono evoluti in diversi lignaggi che aumentano la concentrazione di anidride carbonica rispetto all' ossigeno all' interno del cloroplasto, aumentando l' efficienza della fotosintesi. Questi meccanismi sono chiamati meccanismi di concentrazione dell' anidride carbonica, o CCM. Tra questi figurano il metabolismo degli acidi crassulaceanici, la fissazione del carbonio C4 e i pirenoidi. I cloroplasti negli impianti C4 sono notevoli in quanto presentano un chiaro dimorfismo cloroplastico."
-  text: "Che cosa può fare rubisco per errore?"      
+- text: >-
+    La foresta pluviale amazzonica è diventata per lo più una foresta interna
+    intorno a quale evento globale?
+  context: >-
+    In seguito all' evento di estinzione del Cretaceo-Paleogene, l' estinzione
+    dei dinosauri e il clima umido possono aver permesso alla foresta pluviale
+    tropicale di diffondersi in tutto il continente. Dal 66-34 Mya, la foresta
+    pluviale si estendeva fino a sud fino a 45°. Le fluttuazioni climatiche
+    degli ultimi 34 milioni di anni hanno permesso alle regioni della savana di
+    espandersi fino ai tropici. Durante l' Oligocene, ad esempio, la foresta
+    pluviale ha attraversato una banda relativamente stretta. Si espandeva di
+    nuovo durante il Miocene medio, poi si ritrasse ad una formazione
+    prevalentemente interna all' ultimo massimo glaciale. Tuttavia, la foresta
+    pluviale è riuscita ancora a prosperare durante questi periodi glaciali,
+    consentendo la sopravvivenza e l' evoluzione di un' ampia varietà di specie.
+- text: >-
+    Il Regno Unito e la Francia non hanno avuto interruzioni dell'
+    approvvigionamento petrolifero in quanto non hanno consentito a quale paese
+    di utilizzare il loro aeroporto?
+  context: >-
+    L' embargo non era uniforme in tutta Europa. Dei nove membri della Comunità
+    Economica Europea (CEE), i Paesi Bassi hanno dovuto affrontare un embargo
+    totale, il Regno Unito e la Francia hanno ricevuto forniture quasi
+    ininterrotte (poichè si sono rifiutati di consentire all' America di
+    utilizzare i loro aerodromi e le armi e forniture embargo sia agli arabi che
+    agli israeliani), mentre gli altri sei hanno dovuto affrontare tagli
+    parziali. Il Regno Unito era tradizionalmente un alleato di Israele, e il
+    governo di Harold Wilson ha sostenuto gli israeliani durante la guerra dei
+    sei giorni. Il suo successore, Ted Heath, ribaltò questa politica nel 1970,
+    chiedendo a Israele di ritirarsi ai suoi confini prima del 1967.
+- context: >-
+    Nel 1962, il grafico Paul Rand ridisegna il logo ABC nella sua forma più
+    conosciuta (e attuale) con le lettere minuscole 'abc' racchiuse in un unico
+    cerchio nero. Il nuovo logo esordisce in onda per le promozioni di ABC all'
+    inizio della stagione 1963-64. Le lettere ricordano fortemente il carattere
+    tipografico Bauhaus disegnato da Herbert Bayer negli anni Venti, ma
+    condividono anche similitudini con diversi altri caratteri, come ITC Avant
+    Garde e Horatio, e lo Chalet più simile. La semplicità del logo ha reso più
+    facile la riprogettazione e la duplicazione, il che ha conferito un
+    beneficio per ABC (soprattutto prima dell' avvento della computer grafica).
+  text: Di quale carattere tipografico ricordano le lettere dell' iconico logo ABC?
+- context: >-
+    La fotorespirazione può verificarsi quando la concentrazione di ossigeno è
+    troppo elevata. Rubisco non è in grado di distinguere molto bene tra
+    ossigeno e anidride carbonica, quindi può accidentalmente aggiungere O2
+    invece di CO2 a RuBP. Questo processo riduce l' efficienza della
+    fotosintesi: consuma ATP e ossigeno, rilascia CO2 e non produce zucchero.
+    Può sprecare fino alla metà del carbonio fissato dal ciclo di Calvin.
+    Diversi meccanismi si sono evoluti in diversi lignaggi che aumentano la
+    concentrazione di anidride carbonica rispetto all' ossigeno all' interno del
+    cloroplasto, aumentando l' efficienza della fotosintesi. Questi meccanismi
+    sono chiamati meccanismi di concentrazione dell' anidride carbonica, o CCM.
+    Tra questi figurano il metabolismo degli acidi crassulaceanici, la
+    fissazione del carbonio C4 e i pirenoidi. I cloroplasti negli impianti C4
+    sono notevoli in quanto presentano un chiaro dimorfismo cloroplastico.
+  text: Che cosa può fare rubisco per errore?
 model-index:
 - name: electra-italian-xxl-cased-squad-it
   results:
-  - task: 
+  - task:
       type: question-answering
-      name: "Question Answering"
+      name: Question Answering
     dataset:
       type: squad_it
-      name: "SQuAD-IT"
+      name: SQuAD-IT
     metrics:
-      - type: f1
-        value: 0.775
-        name: "Test F1"
-      - type: exact-match
-        value: 0.660
-        name: "Test Exact Match"
+    - type: f1
+      value: 0.775
+      name: Test F1
+    - type: exact-match
+      value: 0.660
+      name: Test Exact Match
 train-eval-index:
 - config: default
   task: question-answering
@@ -44,4 +94,40 @@ train-eval-index:
     question: question
     answers.text: answers.text
     answers.answer_start: answers.answer_start
----
+
+---
+
+# electra-italian-xxl-cased-squad-it
+
+Electra model for (Extractive) Question Answering on Italian texts
+
+## Model description
+This model has been fine-tuned on [squad_it dataset](https://huggingface.co/datasets/squad_it), starting from the pre-trained model [dbmdz/electra-base-italian-xxl-cased-discriminator](https://huggingface.co/dbmdz/electra-base-italian-xxl-cased-discriminator).
+
+It can be used for [Extractive Q&A](https://huggingface.co/tasks/question-answering) on Italian texts.
+
+## Evaluation
+
+| Metric |   Value   |
+| ------ | --------- |
+| **EM** | **0.660** |
+| **F1** | **0.775** |
+
+TO DO: link evaluation notebook
+
+## Usage in Transformers
+Model checkpoints are available for usage in Pytorch. They can be used directly with pipelines as:
+
+```python
+from transformers import pipelines
+
+qa = pipeline('question-answering', model='anakin87/electra-italian-xxl-cased-squad-it')
+qa(context="Vasco Rossi, noto anche semplicemente come Vasco e in passato con l'appellativo Blasco (Zocca, 7 febbraio 1952), è un cantautore italiano", question="Qual è il soprannome di Vasco Rossi?")
+>>> {'score': 0.93, 'start': 80, 'end': 86, 'answer': 'Blasco'}
+```
+## Usage in Haystack
+
+TO DO: link notebook
+
+## Training procedure
+TO DO: link training notebook