asahi417 commited on
Commit
ccc56cf
1 Parent(s): 4c2c0c0

model update

Browse files
Files changed (1) hide show
  1. README.md +111 -0
README.md ADDED
@@ -0,0 +1,111 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+ ---
3
+ license: cc-by-4.0
4
+ metrics:
5
+ - bleu4
6
+ - meteor
7
+ - rouge-l
8
+ - bertscore
9
+ - moverscore
10
+ language: en
11
+ datasets:
12
+ - lmqg/qg_squad
13
+ pipeline_tag: text2text-generation
14
+ tags:
15
+ - question generation
16
+ widget:
17
+ - text: "<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records."
18
+ example_title: "Question Generation Example 1"
19
+ - text: "Beyonce further expanded her acting career, starring as blues singer <hl> Etta James <hl> in the 2008 musical biopic, Cadillac Records."
20
+ example_title: "Question Generation Example 2"
21
+ - text: "Beyonce further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, <hl> Cadillac Records <hl> ."
22
+ example_title: "Question Generation Example 3"
23
+ model-index:
24
+ - name: lmqg/bart-base-squad-no-answer
25
+ results:
26
+ - task:
27
+ name: Text2text Generation
28
+ type: text2text-generation
29
+ dataset:
30
+ name: lmqg/qg_squad
31
+ type: default
32
+ args: default
33
+ metrics:
34
+ - name: BLEU4
35
+ type: bleu4
36
+ value: 0.2196802868921128
37
+ - name: ROUGE-L
38
+ type: rouge-l
39
+ value: 0.49695872760015636
40
+ - name: METEOR
41
+ type: meteor
42
+ value: 0.23715466422245665
43
+ - name: BERTScore
44
+ type: bertscore
45
+ value: 0.90378149447854
46
+ - name: MoverScore
47
+ type: moverscore
48
+ value: 0.6307014769529157
49
+ ---
50
+
51
+ # Language Models Fine-tuning on Question Generation: `lmqg/bart-base-squad-no-answer`
52
+ This model is fine-tuned version of [facebook/bart-base](https://huggingface.co/facebook/bart-base) for question generation task on the
53
+ [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) (dataset_name: default).
54
+ This model is fine-tuned without answer information, i.e. generate a question only given a paragraph (note that normal model is fine-tuned to generate a question given a pargraph and an associated answer in the paragraph).
55
+
56
+ ### Overview
57
+ - **Language model:** [facebook/bart-base](https://huggingface.co/facebook/bart-base)
58
+ - **Language:** en
59
+ - **Training data:** [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) (default)
60
+ - **Online Demo:** [https://autoqg.net/](https://autoqg.net/)
61
+ - **Repository:** [https://github.com/asahi417/lm-question-generation](https://github.com/asahi417/lm-question-generation)
62
+ - **Paper:** [TBA](TBA)
63
+
64
+ ### Usage
65
+ ```python
66
+
67
+ from transformers import pipeline
68
+
69
+ model_path = 'lmqg/bart-base-squad-no-answer'
70
+ pipe = pipeline("text2text-generation", model_path)
71
+
72
+ # Question Generation
73
+ input_text = '<hl> Beyonce <hl> further expanded her acting career, starring as blues singer Etta James in the 2008 musical biopic, Cadillac Records.'
74
+ question = pipe(input_text)
75
+ ```
76
+
77
+ ## Evaluation Metrics
78
+
79
+
80
+ ### Metrics
81
+
82
+ | Dataset | Type | BLEU4 | ROUGE-L | METEOR | BERTScore | MoverScore | Link |
83
+ |:--------|:-----|------:|--------:|-------:|----------:|-----------:|-----:|
84
+ | [lmqg/qg_squad](https://huggingface.co/datasets/lmqg/qg_squad) | default | 0.2196802868921128 | 0.49695872760015636 | 0.23715466422245665 | 0.90378149447854 | 0.6307014769529157 | [link](https://huggingface.co/lmqg/bart-base-squad-no-answer/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_squad.default.json) |
85
+
86
+
87
+
88
+
89
+ ## Training hyperparameters
90
+
91
+ The following hyperparameters were used during fine-tuning:
92
+ - dataset_path: lmqg/qg_squad
93
+ - dataset_name: default
94
+ - input_types: ['paragraph_sentence']
95
+ - output_types: ['question']
96
+ - prefix_types: None
97
+ - model: facebook/bart-base
98
+ - max_length: 512
99
+ - max_length_output: 32
100
+ - epoch: 4
101
+ - batch: 32
102
+ - lr: 0.0001
103
+ - fp16: False
104
+ - random_seed: 1
105
+ - gradient_accumulation_steps: 8
106
+ - label_smoothing: 0.15
107
+
108
+ The full configuration can be found at [fine-tuning config file](https://huggingface.co/lmqg/bart-base-squad-no-answer/raw/main/trainer_config.json).
109
+
110
+ ## Citation
111
+ TBA