model update

README.md

@@ -33,44 +33,25 @@ model-index:
     metrics:
     - name: BLEU4
       type: bleu4
-      value: 3.8775125297960566e-06
+      value: 0.0
     - name: ROUGE-L
       type: rouge-l
-      value: 0.2370773529266555
+      value: 23.71
     - name: METEOR
       type: meteor
-      value: 0.20603930224653336
+      value: 20.6
     - name: BERTScore
       type: bertscore
-      value: 0.9283541731185314
+      value: 92.84
     - name: MoverScore
       type: moverscore
-      value: 0.6244982140336275
+      value: 62.45
 ---
 
 # Model Card of `lmqg/bart-large-subjqa-books`
-This model is fine-tuned version of [lmqg/bart-large-squad](https://huggingface.co/lmqg/bart-large-squad) for question generation task on the 
-[lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) (dataset_name: books) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
+This model is fine-tuned version of [lmqg/bart-large-squad](https://huggingface.co/lmqg/bart-large-squad) for question generation task on the [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) (dataset_name: books) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
 This model is continuously fine-tuned with [lmqg/bart-large-squad](https://huggingface.co/lmqg/bart-large-squad).
 
-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:** [lmqg/bart-large-squad](https://huggingface.co/lmqg/bart-large-squad)   
 - **Language:** en  
@@ -82,35 +63,40 @@ 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/bart-large-subjqa-books')
+model = TransformersQG(language="en", model="lmqg/bart-large-subjqa-books")
+
 # model prediction
-question = model.generate_q(list_context=["William Turner was an English painter who specialised in watercolour landscapes"], list_answer=["William Turner"])
+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
-# initialize model
-pipe = pipeline("text2text-generation", 'lmqg/bart-large-subjqa-books')
-# question generation
-question = pipe('<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.')
 
-```
+pipe = pipeline("text2text-generation", "lmqg/bart-large-subjqa-books")
+output = pipe("<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.")
 
-## Evaluation Metrics
+```
 
+## Evaluation
 
-### Metrics
 
-| Dataset | Type | BLEU4 | ROUGE-L | METEOR | BERTScore | MoverScore | Link |
-|:--------|:-----|------:|--------:|-------:|----------:|-----------:|-----:|
-| [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) | books | 0.0 | 0.237 | 0.206 | 0.928 | 0.624 | [link](https://huggingface.co/lmqg/bart-large-subjqa-books/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_subjqa.books.json) | 
+- ***Metric (Question Generation)***: [raw metric file](https://huggingface.co/lmqg/bart-large-subjqa-books/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_subjqa.books.json) 
 
+|            |   Score | Type   | Dataset                                                          |
+|:-----------|--------:|:-------|:-----------------------------------------------------------------|
+| BERTScore  |   92.84 | books  | [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) |
+| Bleu_1     |   22.32 | books  | [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) |
+| Bleu_2     |   13.74 | books  | [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) |
+| Bleu_3     |    4.78 | books  | [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) |
+| Bleu_4     |    0    | books  | [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) |
+| METEOR     |   20.6  | books  | [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) |
+| MoverScore |   62.45 | books  | [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) |
+| ROUGE_L    |   23.71 | books  | [lmqg/qg_subjqa](https://huggingface.co/datasets/lmqg/qg_subjqa) |
 
 
 
@@ -137,7 +123,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