model update

README.md

@@ -0,0 +1,111 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: en
+datasets:
+- lmqg/qg_squadshifts
+pipeline_tag: text2text-generation
+tags:
+- question generation
+widget:
+- text: "generate question: <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: "generate question: 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: "generate question: 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: lmqg/t5-base-squadshifts-vanilla-reddit
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_squadshifts
+      type: reddit
+      args: reddit
+    metrics:
+    - name: BLEU4
+      type: bleu4
+      value: 0.06368876631369295
+    - name: ROUGE-L
+      type: rouge-l
+      value: 0.23413349899436356
+    - name: METEOR
+      type: meteor
+      value: 0.19691366998167356
+    - name: BERTScore
+      type: bertscore
+      value: 0.9127928860115689
+    - name: MoverScore
+      type: moverscore
+      value: 0.6018637445444001
+---
+
+# Language Models Fine-tuning on Question Generation: `lmqg/t5-base-squadshifts-vanilla-reddit`
+This model is fine-tuned version of [t5-base](https://huggingface.co/t5-base) for question generation task on the 
+[lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) (dataset_name: reddit).
+
+
+### Overview
+- **Language model:** [t5-base](https://huggingface.co/t5-base)   
+- **Language:** en  
+- **Training data:** [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) (reddit)
+- **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/t5-base-squadshifts-vanilla-reddit'
+pipe = pipeline("text2text-generation", model_path)
+
+# Question Generation
+input_text = 'generate question: <hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.'
+question = pipe(input_text)
+```
+
+## Evaluation Metrics
+
+
+### Metrics
+
+| Dataset | Type | BLEU4 | ROUGE-L | METEOR | BERTScore | MoverScore | Link |
+|:--------|:-----|------:|--------:|-------:|----------:|-----------:|-----:|
+| [lmqg/qg_squadshifts](https://huggingface.co/datasets/lmqg/qg_squadshifts) | reddit | 0.06368876631369295 | 0.23413349899436356 | 0.19691366998167356 | 0.9127928860115689 | 0.6018637445444001 | [link](https://huggingface.co/lmqg/t5-base-squadshifts-vanilla-reddit/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_squadshifts.reddit.json) | 
+
+
+
+
+## Training hyperparameters
+
+The following hyperparameters were used during fine-tuning:
+ - dataset_path: lmqg/qg_squadshifts
+ - dataset_name: reddit
+ - input_types: ['paragraph_answer']
+ - output_types: ['question']
+ - prefix_types: ['qg']
+ - model: t5-base
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 5
+ - batch: 8
+ - lr: 0.0001
+ - fp16: False
+ - random_seed: 1
+ - gradient_accumulation_steps: 8
+ - label_smoothing: 0.15
+
+The full configuration can be found at [fine-tuning config file](https://huggingface.co/lmqg/t5-base-squadshifts-vanilla-reddit/raw/main/trainer_config.json).
+
+## Citation
+TBA