model update

README.md

@@ -29,61 +29,42 @@ model-index:
     metrics:
     - name: BLEU4
       type: bleu4
-      value: 0.10080358110819482
+      value: 10.08
     - name: ROUGE-L
       type: rouge-l
-      value: 0.34193464058970124
+      value: 34.19
     - name: METEOR
       type: meteor
-      value: 0.28019855592470416
+      value: 28.02
     - name: BERTScore
       type: bertscore
-      value: 0.8964198049713776
+      value: 89.64
     - name: MoverScore
       type: moverscore
-      value: 0.6047135052650878
+      value: 60.47
     - name: QAAlignedF1Score (BERTScore)
       type: qa_aligned_f1_score_bertscore
-      value: 0.9142303181239072
+      value: 91.42
     - name: QAAlignedRecall (BERTScore)
       type: qa_aligned_recall_bertscore
-      value: 0.9097622335862658
+      value: 90.98
     - name: QAAlignedPrecision (BERTScore)
       type: qa_aligned_precision_bertscore
-      value: 0.9188558514660737
+      value: 91.89
     - name: QAAlignedF1Score (MoverScore)
       type: qa_aligned_f1_score_moverscore
-      value: 0.6307767033392071
+      value: 63.08
     - name: QAAlignedRecall (MoverScore)
       type: qa_aligned_recall_moverscore
-      value: 0.6215505466446392
+      value: 62.16
     - name: QAAlignedPrecision (MoverScore)
       type: qa_aligned_precision_moverscore
-      value: 0.6408362894345216
+      value: 64.08
 ---
 
 # Model Card of `lmqg/t5-small-tweetqa-qag`
-This model is fine-tuned version of [t5-small](https://huggingface.co/t5-small) for question generation task on the 
-[lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
-This model is fine-tuned on the end-to-end question and answer generation.
+This model is fine-tuned version of [t5-small](https://huggingface.co/t5-small) for question & answer pair generation task on the [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
 
-Please cite our paper if you use the model ([https://arxiv.org/abs/2210.03992](https://arxiv.org/abs/2210.03992)).
-
-```
-
-@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",
-}
-
-```
 
 ### Overview
 - **Language model:** [t5-small](https://huggingface.co/t5-small)   
@@ -96,42 +77,46 @@ Please cite our paper if you use the model ([https://arxiv.org/abs/2210.03992](h
 ### 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='lmqg/t5-small-tweetqa-qag')
+model = TransformersQG(language="en", model="lmqg/t5-small-tweetqa-qag")
+
 # model prediction
-question = model.generate_qa("William Turner was an English painter who specialised in watercolour landscapes")
-        
+question_answer_pairs = model.generate_qa("William Turner was an English painter who specialised in watercolour landscapes")
+
 ```
 
 - With `transformers`
 ```python
-
 from transformers import pipeline
-# initialize model
-pipe = pipeline("text2text-generation", 'lmqg/t5-small-tweetqa-qag')
-# question generation
-question = pipe('generate question and answer: Beyonce further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.')
-
-```
-
-## Evaluation Metrics
 
+pipe = pipeline("text2text-generation", "lmqg/t5-small-tweetqa-qag")
+output = pipe("generate question and answer: Beyonce further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.")
 
-### Metrics
-
-| Dataset | Type | BLEU4 | ROUGE-L | METEOR | BERTScore | MoverScore | Link |
-|:--------|:-----|------:|--------:|-------:|----------:|-----------:|-----:|
-| [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) | default | 0.101 | 0.342 | 0.28 | 0.896 | 0.605 | [link](https://huggingface.co/lmqg/t5-small-tweetqa-qag/raw/main/eval/metric.first.answer.paragraph.questions_answers.lmqg_qag_tweetqa.default.json) | 
+```
 
+## Evaluation
 
-### Metrics (QAG)
 
-| Dataset | Type | QA Aligned F1 Score (BERTScore) | QA Aligned F1 Score (MoverScore) | Link |
-|:--------|:-----|--------------------------------:|---------------------------------:|-----:|
-| [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) | default | 0.914 | 0.631 | [link](https://huggingface.co/lmqg/t5-small-tweetqa-qag/raw/main/eval/metric.first.answer.paragraph.questions_answers.lmqg_qag_tweetqa.default.json) | 
+- ***Metric (Question & Answer Generation)***: [raw metric file](https://huggingface.co/lmqg/t5-small-tweetqa-qag/raw/main/eval/metric.first.answer.paragraph.questions_answers.lmqg_qag_tweetqa.default.json) 
 
+|                                 |   Score | Type    | Dataset                                                              |
+|:--------------------------------|--------:|:--------|:---------------------------------------------------------------------|
+| BERTScore                       |   89.64 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| Bleu_1                          |   35.53 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| Bleu_2                          |   22.94 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| Bleu_3                          |   15.11 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| Bleu_4                          |   10.08 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| METEOR                          |   28.02 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| MoverScore                      |   60.47 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| QAAlignedF1Score (BERTScore)    |   91.42 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| QAAlignedF1Score (MoverScore)   |   63.08 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| QAAlignedPrecision (BERTScore)  |   91.89 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| QAAlignedPrecision (MoverScore) |   64.08 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| QAAlignedRecall (BERTScore)     |   90.98 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| QAAlignedRecall (MoverScore)    |   62.16 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
+| ROUGE_L                         |   34.19 | default | [lmqg/qag_tweetqa](https://huggingface.co/datasets/lmqg/qag_tweetqa) |
 
 
 
@@ -158,7 +143,6 @@ The full configuration can be found at [fine-tuning config file](https://hugging
 
 ## 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