model update

README.md

@@ -0,0 +1,160 @@
+
+---
+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: "<hl> в английском языке в нарицательном смысле применяется термин rapid transit (скоростной городской транспорт), однако употребляется он только тогда, когда по смыслу невозможно ограничиться названием одной конкретной системы метрополитена. <hl> в остальных случаях используются индивидуальные названия: в лондоне — london underground, в нью-йорке — new york subway, в ливерпуле — merseyrail, в вашингтоне — washington metrorail, в сан-франциско — bart и т. п. в некоторых городах применяется название метро (англ. metro) для систем, по своему характеру близких к метро, или для всего городского транспорта (собственно метро и наземный пассажирский транспорт (в том числе автобусы и трамваи)) в совокупности."
+  example_title: "Answer Extraction Example 1" 
+- text: "Вопреки ожиданиям, объединение денежных систем республик не привело к уменьшению инфляции. Напротив, закдензнаки стали невероятно быстро обесцениваться, особенно в 1924 году. Для обеспечения денежного рынка приходилось увеличивать эмиссию закдензнаков и выпускать в оборот купюры невероятно больших номиналов. <hl> Так, в период с 1 января по 20 марта 1924 года были введены в оборот купюры достоинством 25 000 000 рублей, затем — 250 000 000 рублей. <hl> И, наконец, в апреле 1924 года были выпущены купюры миллиардного достоинства (в просторечии лимард)."
+  example_title: "Answer Extraction Example 2" 
+model-index:
+- name: lmqg/mt5-base-ruquad-multitask
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_ruquad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4
+      type: bleu4
+      value: 0.20055947987589695
+    - name: ROUGE-L
+      type: rouge-l
+      value: 0.3534934092216087
+    - name: METEOR
+      type: meteor
+      value: 0.30183590422001033
+    - name: BERTScore
+      type: bertscore
+      value: 0.8790449933583162
+    - name: MoverScore
+      type: moverscore
+      value: 0.6659942800766634
+---
+
+# Model Card of `lmqg/mt5-base-ruquad-multitask`
+This model is fine-tuned version of [google/mt5-base](https://huggingface.co/google/mt5-base) for question generation task on the 
+[lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
+This model is fine-tuned on the answer extraction task as well as the question generation.
+
+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:** [google/mt5-base](https://huggingface.co/google/mt5-base)   
+- **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/mt5-base-ruquad-multitask')
+# model prediction
+question_answer = model.generate_qa("Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, в мае 1860 года провёл серию опытов.")
+
+```
+
+- With `transformers`
+```python
+
+from transformers import pipeline
+# initialize model
+pipe = pipeline("text2text-generation", 'lmqg/mt5-base-ruquad-multitask')
+# answer extraction
+answer = pipe('extract answers: <hl> в английском языке в нарицательном смысле применяется термин rapid transit (скоростной городской транспорт), однако употребляется он только тогда, когда по смыслу невозможно ограничиться названием одной конкретной системы метрополитена. <hl> в остальных случаях используются индивидуальные названия: в лондоне — london underground, в нью-йорке — new york subway, в ливерпуле — merseyrail, в вашингтоне — washington metrorail, в сан-франциско — bart и т. п. в некоторых городах применяется название метро (англ. metro) для систем, по своему характеру близких к метро, или для всего городского транспорта (собственно метро и наземный пассажирский транспорт (в том числе автобусы и трамваи)) в совокупности.')
+# question generation
+question = pipe('generate question: Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, <hl> в мае 1860 года <hl> провёл серию опытов.')
+
+```
+
+## Evaluation Metrics
+
+
+### Metrics
+
+| Dataset | Type | BLEU4 | ROUGE-L | METEOR | BERTScore | MoverScore | Link |
+|:--------|:-----|------:|--------:|-------:|----------:|-----------:|-----:|
+| [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) | default | 0.201 | 0.353 | 0.302 | 0.879 | 0.666 | [link](https://huggingface.co/lmqg/mt5-base-ruquad-multitask/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_ruquad.default.json) | 
+
+
+
+
+## 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: google/mt5-base
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 8
+ - batch: 32
+ - lr: 0.001
+ - fp16: False
+ - random_seed: 1
+ - gradient_accumulation_steps: 2
+ - label_smoothing: 0.15
+
+The full configuration can be found at [fine-tuning config file](https://huggingface.co/lmqg/mt5-base-ruquad-multitask/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/mt5_base_ruquad_answer/best_model",
+  "_name_or_path": "lmqg_output/mt5_base_ruquad_answer/model_ohxpiy/epoch_5",
   "add_prefix": true,
   "architectures": [
     "MT5ForConditionalGeneration"

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

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.3618462707357148, "Bleu_2": 0.2904266262594589, "Bleu_3": 0.23657795764849532, "Bleu_4": 0.19420301607231258}, "test": {"Bleu_1": 0.3650495676017641, "Bleu_2": 0.294098659132727, "Bleu_3": 0.24143141140679847, "Bleu_4": 0.19986981313087115}}

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

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.36316533207724144, "Bleu_2": 0.2913523433670511, "Bleu_3": 0.23716524598614522, "Bleu_4": 0.19458002476922967, "METEOR": 0.30315223807905906, "ROUGE_L": 0.35341304959241093, "BERTScore": 0.8798987069918748, "MoverScore": 0.6673966919200167}, "test": {"Bleu_1": 0.3665809768637454, "Bleu_2": 0.29526812277748854, "Bleu_3": 0.24234962066736138, "Bleu_4": 0.20055947987589695, "METEOR": 0.30183590422001033, "ROUGE_L": 0.3534934092216087, "BERTScore": 0.8790449933583162, "MoverScore": 0.6659942800766634}}

pytorch_model.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:678c729354800d8aad6418d4dac1deee8d83c53945ca12c6d0cb4e6d8dfd7240
-size 2329628621
+oid sha256:b0790d54937fae40bdb66a7654729996eaba187f167c9d8eee2816c5a0d775f1
+size 2329632589

tokenizer_config.json

@@ -2,7 +2,7 @@
   "additional_special_tokens": null,
   "eos_token": "</s>",
   "extra_ids": 0,
-  "name_or_path": "lmqg_output/mt5_base_ruquad_answer/best_model",
+  "name_or_path": "lmqg_output/mt5_base_ruquad_answer/model_ohxpiy/epoch_5",
   "pad_token": "<pad>",
   "sp_model_kwargs": {},
   "special_tokens_map_file": "/home/patrick/.cache/torch/transformers/685ac0ca8568ec593a48b61b0a3c272beee9bc194a3c7241d15dcadb5f875e53.f76030f3ec1b96a8199b2593390c610e76ca8028ef3d24680000619ffb646276",

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": "google/mt5-base", "max_length": 512, "max_length_output": 32, "epoch": 8, "batch": 32, "lr": 0.001, "fp16": false, "random_seed": 1, "gradient_accumulation_steps": 2, "label_smoothing": 0.15}