commit files to HF hub

README.md

@@ -0,0 +1,138 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: en
+datasets:
+- lmqg/qg_squad
+pipeline_tag: text2text-generation
+tags:
+- question generation
+widget:
+- text: "<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records."
+  example_title: "Question Generation Example 1" 
+- text: "Beyonce further expanded her acting career, starring as blues singer <hl> Etta James <hl> in the 2008 musical biopic, Cadillac Records."
+  example_title: "Question Generation Example 2" 
+- text: "Beyonce further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic,  <hl> Cadillac Records <hl> ."
+  example_title: "Question Generation Example 3" 
+model-index:
+- name: vocabtrimmer/mt5-small-trimmed-en-squad-qg
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_squad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Question Generation)
+      type: bleu4_question_generation
+      value: 22.1
+    - name: ROUGE-L (Question Generation)
+      type: rouge_l_question_generation
+      value: 49.52
+    - name: METEOR (Question Generation)
+      type: meteor_question_generation
+      value: 24.03
+    - name: BERTScore (Question Generation)
+      type: bertscore_question_generation
+      value: 90.14
+    - name: MoverScore (Question Generation)
+      type: moverscore_question_generation
+      value: 62.96
+---
+
+# Model Card of `vocabtrimmer/mt5-small-trimmed-en-squad-qg`
+This model is fine-tuned version of [ckpts/mt5-small-trimmed-en](https://huggingface.co/ckpts/mt5-small-trimmed-en) for question generation task on the [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
+
+
+### Overview
+- **Language model:** [ckpts/mt5-small-trimmed-en](https://huggingface.co/ckpts/mt5-small-trimmed-en)   
+- **Language:** en  
+- **Training data:** [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) (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="en", model="vocabtrimmer/mt5-small-trimmed-en-squad-qg")
+
+# model prediction
+questions = model.generate_q(list_context="William Turner was an English painter who specialised in watercolour landscapes", list_answer="William Turner")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-small-trimmed-en-squad-qg")
+output = pipe("<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Generation)***: [raw metric file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-en-squad-qg/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_squad.default.json) 
+
+|            |   Score | Type    | Dataset                                                        |
+|:-----------|--------:|:--------|:---------------------------------------------------------------|
+| BERTScore  |   90.14 | default | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) |
+| Bleu_1     |   54.29 | default | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) |
+| Bleu_2     |   38    | default | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) |
+| Bleu_3     |   28.59 | default | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) |
+| Bleu_4     |   22.1  | default | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) |
+| METEOR     |   24.03 | default | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) |
+| MoverScore |   62.96 | default | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) |
+| ROUGE_L    |   49.52 | default | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) |
+
+
+
+## Training hyperparameters
+
+The following hyperparameters were used during fine-tuning:
+ - dataset_path: lmqg/qg_squad
+ - dataset_name: default
+ - input_types: paragraph_answer
+ - output_types: question
+ - prefix_types: None
+ - model: ckpts/mt5-small-trimmed-en
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 14
+ - 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-en-squad-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_squad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.4976756604352442, "Bleu_2": 0.3459202223846573, "Bleu_3": 0.2616688723054294, "Bleu_4": 0.20486171531553923}, "test": {"Bleu_1": 0.4715033751853957, "Bleu_2": 0.3186131465508769, "Bleu_3": 0.23531067804477135, "Bleu_4": 0.17945203455155642}}

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

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.5488222702445087, "Bleu_2": 0.3909966411855136, "Bleu_3": 0.3004775812485416, "Bleu_4": 0.23791911713402752, "METEOR": 0.25163772630535214, "ROUGE_L": 0.5093495681015933, "BERTScore": 0.9032234181719199, "MoverScore": 0.6428409552998015}, "test": {"Bleu_1": 0.5428927385681106, "Bleu_2": 0.3799589915652636, "Bleu_3": 0.285912356670564, "Bleu_4": 0.2210378574322067, "METEOR": 0.2403097598352176, "ROUGE_L": 0.4951569369325176, "BERTScore": 0.9014252323435504, "MoverScore": 0.6295963578382986}}