model update

README.md

@@ -0,0 +1,215 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: ru
+datasets:
+- lmqg/qg_ruquad
+pipeline_tag: text2text-generation
+tags:
+- question generation
+- answer extraction
+widget:
+- text: "generate question: Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, <hl> в мае 1860 года <hl> провёл серию опытов."
+  example_title: "Question Generation Example 1" 
+- text: "generate question: Однако, франкоязычный <hl> Квебек <hl> практически никогда не включается в состав Латинской Америки."
+  example_title: "Question Generation Example 2" 
+- text: "generate question: Классическим примером международного синдиката XX века была группа компаний <hl> Де Бирс <hl> , которая в 1980-е годы контролировала до 90 % мировой торговли алмазами."
+  example_title: "Question Generation Example 3" 
+- text: "extract answers: <hl> в английском языке в нарицательном смысле применяется термин rapid transit (скоростной городской транспорт), однако употребляется он только тогда, когда по смыслу невозможно ограничиться названием одной конкретной системы метрополитена. <hl> в остальных случаях используются индивидуальные названия: в лондоне — london underground, в нью-йорке — new york subway, в ливерпуле — merseyrail, в вашингтоне — washington metrorail, в сан-франциско — bart и т. п. в некоторых городах применяется название метро (англ. metro) для систем, по своему характеру близких к метро, или для всего городского транспорта (собственно метро и наземный пассажирский транспорт (в том числе автобусы и трамваи)) в совокупности."
+  example_title: "Answer Extraction Example 1" 
+- text: "extract answers: Вопреки ожиданиям, объединение денежных систем республик не привело к уменьшению инфляции. Напротив, закдензнаки стали невероятно быстро обесцениваться, особенно в 1924 году. Для обеспечения денежного рынка приходилось увеличивать эмиссию закдензнаков и выпускать в оборот купюры невероятно больших номиналов. <hl> Так, в период с 1 января по 20 марта 1924 года были введены в оборот купюры достоинством 25 000 000 рублей, затем — 250 000 000 рублей. <hl> И, наконец, в апреле 1924 года были выпущены купюры миллиардного достоинства (в просторечии лимард)."
+  example_title: "Answer Extraction Example 2" 
+model-index:
+- name: lmqg/mbart-large-cc25-ruquad-qg-ae
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_ruquad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Question Generation)
+      type: bleu4_question_generation
+      value: 17.97
+    - name: ROUGE-L (Question Generation)
+      type: rouge_l_question_generation
+      value: 33.61
+    - name: METEOR (Question Generation)
+      type: meteor_question_generation
+      value: 29.35
+    - name: BERTScore (Question Generation)
+      type: bertscore_question_generation
+      value: 86.5
+    - name: MoverScore (Question Generation)
+      type: moverscore_question_generation
+      value: 65.37
+    - name: QAAlignedF1Score-BERTScore (Question & Answer Generation (with Gold Answer))
+      type: qa_aligned_f1_score_bertscore_question_answer_generation_with_gold_answer
+      value: 60.14
+    - name: QAAlignedRecall-BERTScore (Question & Answer Generation (with Gold Answer))
+      type: qa_aligned_recall_bertscore_question_answer_generation_with_gold_answer
+      value: 62.21
+    - name: QAAlignedPrecision-BERTScore (Question & Answer Generation (with Gold Answer))
+      type: qa_aligned_precision_bertscore_question_answer_generation_with_gold_answer
+      value: 58.32
+    - name: QAAlignedF1Score-MoverScore (Question & Answer Generation (with Gold Answer))
+      type: qa_aligned_f1_score_moverscore_question_answer_generation_with_gold_answer
+      value: 42.22
+    - name: QAAlignedRecall-MoverScore (Question & Answer Generation (with Gold Answer))
+      type: qa_aligned_recall_moverscore_question_answer_generation_with_gold_answer
+      value: 43.58
+    - name: QAAlignedPrecision-MoverScore (Question & Answer Generation (with Gold Answer))
+      type: qa_aligned_precision_moverscore_question_answer_generation_with_gold_answer
+      value: 41.05
+    - name: BLEU4 (Answer Extraction)
+      type: bleu4_answer_extraction
+      value: 30.37
+    - name: ROUGE-L (Answer Extraction)
+      type: rouge_l_answer_extraction
+      value: 48.9
+    - name: METEOR (Answer Extraction)
+      type: meteor_answer_extraction
+      value: 38.32
+    - name: BERTScore (Answer Extraction)
+      type: bertscore_answer_extraction
+      value: 85.62
+    - name: MoverScore (Answer Extraction)
+      type: moverscore_answer_extraction
+      value: 73.64
+    - name: AnswerF1Score (Answer Extraction)
+      type: answer_f1_score__answer_extraction
+      value: 63.23
+    - name: AnswerExactMatch (Answer Extraction)
+      type: answer_exact_match_answer_extraction
+      value: 42.67
+---
+
+# Model Card of `lmqg/mbart-large-cc25-ruquad-qg-ae`
+This model is fine-tuned version of [facebook/mbart-large-cc25](https://huggingface.co/facebook/mbart-large-cc25) for question generation and answer extraction jointly on the [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
+
+
+### Overview
+- **Language model:** [facebook/mbart-large-cc25](https://huggingface.co/facebook/mbart-large-cc25)   
+- **Language:** ru  
+- **Training data:** [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) (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:** [https://arxiv.org/abs/2210.03992](https://arxiv.org/abs/2210.03992)
+
+### 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="ru", model="lmqg/mbart-large-cc25-ruquad-qg-ae")
+
+# model prediction
+question_answer_pairs = model.generate_qa("Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, в мае 1860 года провёл серию опытов.")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "lmqg/mbart-large-cc25-ruquad-qg-ae")
+
+# answer extraction
+answer = pipe("generate question: Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, <hl> в мае 1860 года <hl> провёл серию опытов.")
+
+# question generation
+question = pipe("extract answers: <hl> в английском языке в нарицательном смысле применяется термин rapid transit (скоростной городской транспорт), однако употребляется он только тогда, когда по смыслу невозможно ограничиться названием одной конкретной системы метрополитена. <hl> в остальных случаях используются индивидуальные названия: в лондоне — london underground, в нью-йорке — new york subway, в ливерпуле — merseyrail, в вашингтоне — washington metrorail, в сан-франциско — bart и т. п. в некоторых городах применяется название метро (англ. metro) для систем, по своему характеру близких к метро, или для всего городского транспорта (собственно метро и наземный пассажирский транспорт (в том числе автобусы и трамваи)) в совокупности.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Generation)***: [raw metric file](https://huggingface.co/lmqg/mbart-large-cc25-ruquad-qg-ae/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_ruquad.default.json) 
+
+|            |   Score | Type    | Dataset                                                          |
+|:-----------|--------:|:--------|:-----------------------------------------------------------------|
+| BERTScore  |   86.5  | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_1     |   34.01 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_2     |   26.99 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_3     |   21.9  | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_4     |   17.97 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| METEOR     |   29.35 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| MoverScore |   65.37 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| ROUGE_L    |   33.61 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+
+
+- ***Metric (Question & Answer Generation)***:  [raw metric file](https://huggingface.co/lmqg/mbart-large-cc25-ruquad-qg-ae/raw/main/eval/metric.first.answer.paragraph.questions_answers.lmqg_qg_ruquad.default.json)
+
+|                                 |   Score | Type    | Dataset                                                          |
+|:--------------------------------|--------:|:--------|:-----------------------------------------------------------------|
+| QAAlignedF1Score (BERTScore)    |   60.14 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| QAAlignedF1Score (MoverScore)   |   42.22 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| QAAlignedPrecision (BERTScore)  |   58.32 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| QAAlignedPrecision (MoverScore) |   41.05 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| QAAlignedRecall (BERTScore)     |   62.21 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| QAAlignedRecall (MoverScore)    |   43.58 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+
+
+- ***Metric (Answer Extraction)***: [raw metric file](https://huggingface.co/lmqg/mbart-large-cc25-ruquad-qg-ae/raw/main/eval/metric.first.answer.paragraph_sentence.answer.lmqg_qg_ruquad.default.json)
+
+|                  |   Score | Type    | Dataset                                                          |
+|:-----------------|--------:|:--------|:-----------------------------------------------------------------|
+| AnswerExactMatch |   42.67 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| AnswerF1Score    |   63.23 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| BERTScore        |   85.62 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_1           |   44.16 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_2           |   39.37 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_3           |   34.9  | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_4           |   30.37 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| METEOR           |   38.32 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| MoverScore       |   73.64 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| ROUGE_L          |   48.9  | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+
+
+
+## Training hyperparameters
+
+The following hyperparameters were used during fine-tuning:
+ - dataset_path: lmqg/qg_ruquad
+ - dataset_name: default
+ - input_types: ['paragraph_answer', 'paragraph_sentence']
+ - output_types: ['question', 'answer']
+ - prefix_types: ['qg', 'ae']
+ - model: facebook/mbart-large-cc25
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 12
+ - batch: 2
+ - lr: 0.0001
+ - fp16: False
+ - random_seed: 1
+ - gradient_accumulation_steps: 32
+ - label_smoothing: 0.15
+
+The full configuration can be found at [fine-tuning config file](https://huggingface.co/lmqg/mbart-large-cc25-ruquad-qg-ae/raw/main/trainer_config.json).
+
+## 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
+        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",
+}
+
+```

config.json

@@ -1,5 +1,5 @@
 {
-  "_name_or_path": "lmqg_output/mbart-large-cc25-ruquad-qg-ae/best_model",
+  "_name_or_path": "lmqg_output/mbart-large-cc25-ruquad-qg-ae/model_yzhvsi/epoch_5",
   "_num_labels": 3,
   "activation_dropout": 0.0,
   "activation_function": "gelu",

eval/metric.first.answer.paragraph.questions_answers.lmqg_qg_ruquad.default.json

@@ -0,0 +1 @@
+{"test": {"QAAlignedF1Score (BERTScore)": 0.6014372715590431, "QAAlignedRecall (BERTScore)": 0.6220816234742623, "QAAlignedPrecision (BERTScore)": 0.5831608930684375, "QAAlignedF1Score (MoverScore)": 0.42216668630361814, "QAAlignedRecall (MoverScore)": 0.43582919549193205, "QAAlignedPrecision (MoverScore)": 0.4104933801379602, "Bleu_1": 0.07936670794488958, "Bleu_2": 0.03209520506569656, "Bleu_3": 0.017754856212603077, "Bleu_4": 0.011035139351888925, "METEOR": 0.14106350877032667, "ROUGE_L": 0.10903112318490889, "BERTScore": 0.519944298169433, "MoverScore": 0.4994248535875407}, "validation": {"QAAlignedF1Score (BERTScore)": 0.5924273151480047, "QAAlignedRecall (BERTScore)": 0.6126118175101513, "QAAlignedPrecision (BERTScore)": 0.5745262301728905, "QAAlignedF1Score (MoverScore)": 0.41593630003405263, "QAAlignedRecall (MoverScore)": 0.4292269022032105, "QAAlignedPrecision (MoverScore)": 0.4045485561560094, "Bleu_1": 0.07860128971222732, "Bleu_2": 0.03128184304745291, "Bleu_3": 0.017573932159518437, "Bleu_4": 0.010664449524296264, "METEOR": 0.138334975700761, "ROUGE_L": 0.10724067817062491, "BERTScore": 0.5120050816244868, "MoverScore": 0.4985037956544231}}

eval/metric.first.answer.paragraph_answer.question.lmqg_qg_ruquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.334960995652944, "Bleu_2": 0.26604029096112286, "Bleu_3": 0.2154952342158938, "Bleu_4": 0.17657026575769336}, "test": {"Bleu_1": 0.3380343151839663, "Bleu_2": 0.26829274187341595, "Bleu_3": 0.21764184473253623, "Bleu_4": 0.1785481276669253}}

eval/metric.first.answer.paragraph_sentence.answer.lmqg_qg_ruquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.4444109671587636, "Bleu_2": 0.39590623629571087, "Bleu_3": 0.3518706173804563, "Bleu_4": 0.3066860744750603, "METEOR": 0.3813796709142597, "ROUGE_L": 0.48926245707789984, "BERTScore": 0.8573595547162417, "MoverScore": 0.7397204261640233, "AnswerF1Score": 63.50671910709193, "AnswerExactMatch": 43.506751389992054}, "test": {"Bleu_1": 0.44164670006532597, "Bleu_2": 0.3936741302565208, "Bleu_3": 0.3489534414777692, "Bleu_4": 0.303676045610284, "METEOR": 0.38318582826818054, "ROUGE_L": 0.4890006479084039, "BERTScore": 0.8561733973118594, "MoverScore": 0.7363506512943487, "AnswerF1Score": 63.233585669165585, "AnswerExactMatch": 42.67275615567911}}

eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_ruquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.33657995563621024, "Bleu_2": 0.26722334905811956, "Bleu_3": 0.21633786326939014, "Bleu_4": 0.17719759515258895, "METEOR": 0.293470313422919, "ROUGE_L": 0.3365495598206828, "BERTScore": 0.8654427092545651, "MoverScore": 0.6558733568485419}, "test": {"Bleu_1": 0.3400680861349971, "Bleu_2": 0.26987916266074424, "Bleu_3": 0.2190001430195806, "Bleu_4": 0.17969794959772686, "METEOR": 0.2934713906190754, "ROUGE_L": 0.3360602288417497, "BERTScore": 0.8650157981648786, "MoverScore": 0.6536732448866794}}

pytorch_model.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:3ae601852b9c580f81fcb41ba1b1bdd65c369a43d428e0b865123dbb3dbe0002
-size 2444580125
+oid sha256:a2a9439e11313ce3e6d8cdf48813756d23e3499471fe7a0fb931ddb0f373ba72
+size 2444587421

tokenizer_config.json

@@ -12,7 +12,7 @@
     "single_word": false
   },
   "model_max_length": 1024,
-  "name_or_path": "lmqg_output/mbart-large-cc25-ruquad-qg-ae/best_model",
+  "name_or_path": "lmqg_output/mbart-large-cc25-ruquad-qg-ae/model_yzhvsi/epoch_5",
   "pad_token": "<pad>",
   "sep_token": "</s>",
   "special_tokens_map_file": null,

trainer_config.json

@@ -0,0 +1 @@
+{"dataset_path": "lmqg/qg_ruquad", "dataset_name": "default", "input_types": ["paragraph_answer", "paragraph_sentence"], "output_types": ["question", "answer"], "prefix_types": ["qg", "ae"], "model": "facebook/mbart-large-cc25", "max_length": 512, "max_length_output": 32, "epoch": 12, "batch": 2, "lr": 0.0001, "fp16": false, "random_seed": 1, "gradient_accumulation_steps": 32, "label_smoothing": 0.15}