model update

README.md

@@ -1,24 +1,111 @@
+
 ---
-language: 
-  - en
-tags:
-- question generation
-- question answer generation
-license: mit
-datasets:
-- squad
+license: cc-by-4.0
 metrics:
-- bleu
+- bleu4
 - meteor
-- rouge
+- 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: "Example 1"
+  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: "Example 2"
+  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: "Example 3"
+  example_title: "Question Generation Example 3" 
+model-index:
+- name: lmqg/bart-base-squad-default
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_squad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4
+      type: bleu4
+      value: 0.24400683975723286
+    - name: ROUGE-L
+      type: rouge-l
+      value: 0.5248717762722197
+    - name: METEOR
+      type: meteor
+      value: 0.25985179074924764
+    - name: BERTScore
+      type: bertscore
+      value: 0.9086545639846674
+    - name: MoverScore
+      type: moverscore
+      value: 0.644778282518877
 ---
 
-# T5 finetuned on Question Generation
-T5 model for question generation. Please visit [our repository](https://github.com/asahi417/t5-question-generation) for more detail.
+# Language Models Fine-tuning on Question Generation: `lmqg/bart-base-squad-default`
+This model is fine-tuned version of [facebook/bart-base](https://huggingface.co/facebook/bart-base) for question generation task on the 
+[lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) (dataset_name: default).
+
+### Overview
+- **Language model:** [facebook/bart-base](https://huggingface.co/facebook/bart-base)   
+- **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:** [TBA](TBA)
+
+### Usage
+```python
+
+from transformers import pipeline
+
+model_path = 'lmqg/bart-base-squad-default'
+pipe = pipeline("text2text-generation", model_path)
+
+# Question Generation
+input_text = '<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.'
+generation = pipe(input_text)
+```
+
+## Evaluation Metrics
+### In-domain Metrics
+
+
+| Dataset | Type | BLEU4 | ROUGE-L | METEOR | BERTScore | MoverScore | Link |
+|:--------|:-----|------:|--------:|-------:|----------:|-----------:|-----:|
+| [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) | default | 0.24400683975723286 | 0.5248717762722197 | 0.25985179074924764 | 0.9086545639846674 | 0.644778282518877 | [link](https://huggingface.co/lmqg/bart-base-squad-default/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_squad.default.json) | 
+
+
+### Out-of-domain Metrics
+
+
+
+## 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: facebook/bart-base
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 10
+ - batch: 32
+ - lr: 1.25e-05
+ - fp16: False
+ - random_seed: 1
+ - gradient_accumulation_steps: 1
+ - label_smoothing: 0.1
+
+The full configuration can be found at [fine-tuning config file](https://huggingface.co/lmqg/bart-base-squad-default/raw/main/trainer_config.json).
+
+## Citation
+TBA