commit files to HF hub

README.md

@@ -0,0 +1,138 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: it
+datasets:
+- lmqg/qg_itquad
+pipeline_tag: text2text-generation
+tags:
+- question generation
+widget:
+- text: "<hl> Dopo il 1971 <hl> , l' OPEC ha tardato ad adeguare i prezzi per riflettere tale deprezzamento."
+  example_title: "Question Generation Example 1" 
+- text: "L' individuazione del petrolio e lo sviluppo di nuovi giacimenti richiedeva in genere <hl> da cinque a dieci anni <hl> prima di una produzione significativa."
+  example_title: "Question Generation Example 2" 
+- text: "il <hl> Giappone <hl> è stato il paese più dipendente dal petrolio arabo."
+  example_title: "Question Generation Example 3" 
+model-index:
+- name: vocabtrimmer/mt5-small-trimmed-it-90000-itquad-qg
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_itquad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Question Generation)
+      type: bleu4_question_generation
+      value: 7.44
+    - name: ROUGE-L (Question Generation)
+      type: rouge_l_question_generation
+      value: 21.8
+    - name: METEOR (Question Generation)
+      type: meteor_question_generation
+      value: 17.42
+    - name: BERTScore (Question Generation)
+      type: bertscore_question_generation
+      value: 80.82
+    - name: MoverScore (Question Generation)
+      type: moverscore_question_generation
+      value: 56.73
+---
+
+# Model Card of `vocabtrimmer/mt5-small-trimmed-it-90000-itquad-qg`
+This model is fine-tuned version of [vocabtrimmer/mt5-small-trimmed-it-90000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-it-90000) for question generation 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-90000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-it-90000)   
+- **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-90000-itquad-qg")
+
+# model prediction
+questions = model.generate_q(list_context="Dopo il 1971 , l' OPEC ha tardato ad adeguare i prezzi per riflettere tale deprezzamento.", list_answer="Dopo il 1971")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-small-trimmed-it-90000-itquad-qg")
+output = pipe("<hl> Dopo il 1971 <hl> , l' OPEC ha tardato ad adeguare i prezzi per riflettere tale deprezzamento.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Generation)***: [raw metric file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-it-90000-itquad-qg/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_itquad.default.json) 
+
+|            |   Score | Type    | Dataset                                                          |
+|:-----------|--------:|:--------|:-----------------------------------------------------------------|
+| BERTScore  |   80.82 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| Bleu_1     |   22.84 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| Bleu_2     |   15    | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| Bleu_3     |   10.42 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| Bleu_4     |    7.44 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| METEOR     |   17.42 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| MoverScore |   56.73 | default | [lmqg/qg_itquad](https://huggingface.co/datasets/lmqg/qg_itquad) |
+| ROUGE_L    |   21.8  | 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_answer
+ - output_types: question
+ - prefix_types: None
+ - model: vocabtrimmer/mt5-small-trimmed-it-90000
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 15
+ - batch: 16
+ - lr: 0.0005
+ - fp16: False
+ - random_seed: 1
+ - gradient_accumulation_steps: 4
+ - label_smoothing: 0.15
+
+The full configuration can be found at [fine-tuning config file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-it-90000-itquad-qg/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_answer.question.lmqg_qg_itquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.22566787944733216, "Bleu_2": 0.14823600169672574, "Bleu_3": 0.10294683485861444, "Bleu_4": 0.0736215829183466}, "test": {"Bleu_1": 0.21829816442663, "Bleu_2": 0.14254264535194142, "Bleu_3": 0.09882710926265972, "Bleu_4": 0.0705047974104006}}

eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_itquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.22655147489071437, "Bleu_2": 0.14900150063316414, "Bleu_3": 0.10359425965889371, "Bleu_4": 0.07417055528426361, "METEOR": 0.17981238940719682, "ROUGE_L": 0.21832190956175282, "BERTScore": 0.814592626791607, "MoverScore": 0.5717780975262446}, "test": {"Bleu_1": 0.22836154193461508, "Bleu_2": 0.14996824528801014, "Bleu_3": 0.10418093314014228, "Bleu_4": 0.07435015638097323, "METEOR": 0.17423046841050133, "ROUGE_L": 0.21803381727621296, "BERTScore": 0.8082144334923094, "MoverScore": 0.5672830014873522}}