commit files to HF hub

README.md

@@ -0,0 +1,138 @@
+
+---
+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
+widget:
+- text: "Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, <hl> в мае 1860 года <hl> провёл серию опытов."
+  example_title: "Question Generation Example 1" 
+- text: "Однако, франкоязычный <hl> Квебек <hl> практически никогда не включается в состав Латинской Америки."
+  example_title: "Question Generation Example 2" 
+- text: "Классическим примером международного синдиката XX века была группа компаний <hl> Де Бирс <hl> , которая в 1980-е годы контролировала до 90 % мировой торговли алмазами."
+  example_title: "Question Generation Example 3" 
+model-index:
+- name: vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qg
+  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: 18.11
+    - name: ROUGE-L (Question Generation)
+      type: rouge_l_question_generation
+      value: 32.84
+    - name: METEOR (Question Generation)
+      type: meteor_question_generation
+      value: 27.7
+    - name: BERTScore (Question Generation)
+      type: bertscore_question_generation
+      value: 85.89
+    - name: MoverScore (Question Generation)
+      type: moverscore_question_generation
+      value: 63.99
+---
+
+# Model Card of `vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qg`
+This model is fine-tuned version of [vocabtrimmer/mt5-small-trimmed-ru-5000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-ru-5000) 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).
+
+
+### Overview
+- **Language model:** [vocabtrimmer/mt5-small-trimmed-ru-5000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-ru-5000)   
+- **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="vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qg")
+
+# model prediction
+questions = model.generate_q(list_context="Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, в мае 1860 года провёл серию опытов.", list_answer="в мае 1860 года")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qg")
+output = pipe("Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, <hl> в мае 1860 года <hl> провёл серию опытов.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Generation)***: [raw metric file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qg/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_ruquad.default.json) 
+
+|            |   Score | Type    | Dataset                                                          |
+|:-----------|--------:|:--------|:-----------------------------------------------------------------|
+| BERTScore  |   85.89 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_1     |   33.9  | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_2     |   27.03 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_3     |   21.98 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_4     |   18.11 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| METEOR     |   27.7  | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| MoverScore |   63.99 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| ROUGE_L    |   32.84 | 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
+ - output_types: question
+ - prefix_types: None
+ - model: vocabtrimmer/mt5-small-trimmed-ru-5000
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 9
+ - batch: 16
+ - lr: 0.001
+ - fp16: False
+ - random_seed: 1
+ - gradient_accumulation_steps: 4
+ - label_smoothing: 0.15
+
+The full configuration can be found at [fine-tuning config file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qg/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",
+}
+
+```

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

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.33323020440153595, "Bleu_2": 0.26470998793218703, "Bleu_3": 0.2139568271125248, "Bleu_4": 0.17480922076421068}, "test": {"Bleu_1": 0.33688396241964036, "Bleu_2": 0.268631472631107, "Bleu_3": 0.21852280912727243, "Bleu_4": 0.18002580188556194}}

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

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.33483442598914326, "Bleu_2": 0.26596888349329795, "Bleu_3": 0.21497285755105475, "Bleu_4": 0.17565047953392995, "METEOR": 0.2773956745082658, "ROUGE_L": 0.3282422738500797, "BERTScore": 0.8594390359252493, "MoverScore": 0.6407921382112461}, "test": {"Bleu_1": 0.339000418235041, "Bleu_2": 0.2702824314533164, "Bleu_3": 0.21983029496766632, "Bleu_4": 0.18105948228750052, "METEOR": 0.2770127167278592, "ROUGE_L": 0.3284407933203291, "BERTScore": 0.858903289381471, "MoverScore": 0.6398641873490714}}