commit files to HF hub

README.md

@@ -0,0 +1,142 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: it
+datasets:
+- lmqg/qg_itquad
+pipeline_tag: text2text-generation
+tags:
+- question answering
+widget:
+- text: "question: Quale batterio ha il nome del paese che colpisce di più nel suo nome?, context: Il complesso M. tubercolosi (MTBC) comprende altri quattro micobatteri causa di tubercolosi: M. bovis, M. africanum, M. canetti e M. microti. M. africanum non è molto diffuso, ma è una causa significativa di tubercolosi in alcune parti dell' Africa. M. bovis era una volta una causa comune della tubercolosi, ma l' introduzione del latte pastorizzato ha quasi completamente eliminato questo problema di salute pubblica nei paesi sviluppati. M. canetti è raro e sembra essere limitato al Corno d' Africa, anche se alcuni casi sono stati osservati negli emigranti africani. M. microti è anche raro ed è visto quasi solo in persone immunodeficienti, anche se la sua prevalenza può essere significativamente sottovalutata."
+  example_title: "Question Answering Example 1" 
+model-index:
+- name: vocabtrimmer/mt5-small-trimmed-it-10000-itquad-qa
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_itquad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Question Answering)
+      type: bleu4_question_answering
+      value: 13.38
+    - name: ROUGE-L (Question Answering)
+      type: rouge_l_question_answering
+      value: 35.34
+    - name: METEOR (Question Answering)
+      type: meteor_question_answering
+      value: 32.02
+    - name: BERTScore (Question Answering)
+      type: bertscore_question_answering
+      value: 91.96
+    - name: MoverScore (Question Answering)
+      type: moverscore_question_answering
+      value: 78.62
+    - name: AnswerF1Score (Question Answering)
+      type: answer_f1_score__question_answering
+      value: 61.45
+    - name: AnswerExactMatch (Question Answering)
+      type: answer_exact_match_question_answering
+      value: 46.8
+---
+
+# Model Card of `vocabtrimmer/mt5-small-trimmed-it-10000-itquad-qa`
+This model is fine-tuned version of [vocabtrimmer/mt5-small-trimmed-it-10000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-it-10000) for question answering task on the [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
+
+
+### Overview
+- **Language model:** [vocabtrimmer/mt5-small-trimmed-it-10000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-it-10000)   
+- **Language:** it  
+- **Training data:** [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) (default)
+- **Online Demo:** [https://autoqg.net/](https://autoqg.net/)
+- **Repository:** [https://github.com/asahi417/lm-question-generation](https://github.com/asahi417/lm-question-generation)
+- **Paper:** [https://arxiv.org/abs/2210.03992](https://arxiv.org/abs/2210.03992)
+
+### Usage
+- With [`lmqg`](https://github.com/asahi417/lm-question-generation#lmqg-language-model-for-question-generation-)
+```python
+from lmqg import TransformersQG
+
+# initialize model
+model = TransformersQG(language="it", model="vocabtrimmer/mt5-small-trimmed-it-10000-itquad-qa")
+
+# model prediction
+answers = model.answer_q(list_question="Quale batterio ha il nome del paese che colpisce di più nel suo nome?", list_context=" Il complesso M. tubercolosi (MTBC) comprende altri quattro micobatteri causa di tubercolosi: M. bovis, M. africanum, M. canetti e M. microti. M. africanum non è molto diffuso, ma è una causa significativa di tubercolosi in alcune parti dell' Africa. M. bovis era una volta una causa comune della tubercolosi, ma l' introduzione del latte pastorizzato ha quasi completamente eliminato questo problema di salute pubblica nei paesi sviluppati. M. canetti è raro e sembra essere limitato al Corno d' Africa, anche se alcuni casi sono stati osservati negli emigranti africani. M. microti è anche raro ed è visto quasi solo in persone immunodeficienti, anche se la sua prevalenza può essere significativamente sottovalutata.")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-small-trimmed-it-10000-itquad-qa")
+output = pipe("question: Quale batterio ha il nome del paese che colpisce di più nel suo nome?, context: Il complesso M. tubercolosi (MTBC) comprende altri quattro micobatteri causa di tubercolosi: M. bovis, M. africanum, M. canetti e M. microti. M. africanum non è molto diffuso, ma è una causa significativa di tubercolosi in alcune parti dell' Africa. M. bovis era una volta una causa comune della tubercolosi, ma l' introduzione del latte pastorizzato ha quasi completamente eliminato questo problema di salute pubblica nei paesi sviluppati. M. canetti è raro e sembra essere limitato al Corno d' Africa, anche se alcuni casi sono stati osservati negli emigranti africani. M. microti è anche raro ed è visto quasi solo in persone immunodeficienti, anche se la sua prevalenza può essere significativamente sottovalutata.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Answering)***: [raw metric file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-it-10000-itquad-qa/raw/main/eval/metric.first.answer.paragraph_question.answer.lmqg_qg_itquad.default.json) 
+
+|                  |   Score | Type    | Dataset                                                          |
+|:-----------------|--------:|:--------|:-----------------------------------------------------------------|
+| AnswerExactMatch |   46.8  | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| AnswerF1Score    |   61.45 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| BERTScore        |   91.96 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| Bleu_1           |   25.43 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| Bleu_2           |   19.97 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| Bleu_3           |   16.35 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| Bleu_4           |   13.38 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| METEOR           |   32.02 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| MoverScore       |   78.62 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| ROUGE_L          |   35.34 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+
+
+
+## Training hyperparameters
+
+The following hyperparameters were used during fine-tuning:
+ - dataset_path: lmqg/qg_itquad
+ - dataset_name: default
+ - input_types: ['paragraph_question']
+ - output_types: ['answer']
+ - prefix_types: None
+ - model: vocabtrimmer/mt5-small-trimmed-it-10000
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 15
+ - batch: 32
+ - lr: 0.0005
+ - fp16: False
+ - random_seed: 1
+ - gradient_accumulation_steps: 2
+ - label_smoothing: 0.15
+
+The full configuration can be found at [fine-tuning config file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-it-10000-itquad-qa/raw/main/trainer_config.json).
+
+## Citation
+```
+@inproceedings{ushio-etal-2022-generative,
+    title = "{G}enerative {L}anguage {M}odels for {P}aragraph-{L}evel {Q}uestion {G}eneration",
+    author = "Ushio, Asahi  and
+        Alva-Manchego, Fernando  and
+        Camacho-Collados, Jose",
+    booktitle = "Proceedings of the 2022 Conference on Empirical Methods in Natural Language Processing",
+    month = dec,
+    year = "2022",
+    address = "Abu Dhabi, U.A.E.",
+    publisher = "Association for Computational Linguistics",
+}
+
+```

eval/metric.first.answer.paragraph_question.answer.lmqg_qg_itquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.2607245543415656, "Bleu_2": 0.20326964387861937, "Bleu_3": 0.16534111354004846, "Bleu_4": 0.13354392676819124, "METEOR": 0.3400859259227173, "ROUGE_L": 0.3530582318957219, "BERTScore": 0.930419608271064, "MoverScore": 0.812546801139855, "AnswerF1Score": 65.44802488667791, "AnswerExactMatch": 52.713891444342224}, "test": {"Bleu_1": 0.25430431966178263, "Bleu_2": 0.19965745092437287, "Bleu_3": 0.16354406152154402, "Bleu_4": 0.13381625492092308, "METEOR": 0.3202429040863493, "ROUGE_L": 0.35339171335489605, "BERTScore": 0.9195870688638701, "MoverScore": 0.7862035918950931, "AnswerF1Score": 61.45115361953939, "AnswerExactMatch": 46.7998422920226}}