model update

README.md

@@ -0,0 +1,118 @@
+
+---
+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-small-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.18064142309448245
+    - name: ROUGE-L
+      type: rouge-l
+      value: 0.33780523556447417
+    - name: METEOR
+      type: meteor
+      value: 0.289216348958004
+    - name: BERTScore
+      type: bertscore
+      value: 0.8628808111702687
+    - name: MoverScore
+      type: moverscore
+      value: 0.6501855498621383
+---
+
+# Language Models Fine-tuning on Question Generation: `lmqg/mt5-small-ruquad-multitask`
+This model is fine-tuned version of [google/mt5-small](https://huggingface.co/google/mt5-small) for question generation task on the 
+[lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) (dataset_name: default).
+This model is fine-tuned on the answer extraction task as well as the question generation.
+
+### Overview
+- **Language model:** [google/mt5-small](https://huggingface.co/google/mt5-small)   
+- **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:** [TBA](TBA)
+
+### Usage
+```python
+
+from transformers import pipeline
+
+model_path = 'lmqg/mt5-small-ruquad-multitask'
+pipe = pipeline("text2text-generation", model_path)
+
+# Question Generation
+input_text = 'generate question: Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, <hl> в мае 1860 года <hl> провёл серию опытов.'
+question = pipe(input_text)
+# Answer Extraction
+answer = pipe('extract answers: <hl> в английском языке в нарицательном смысле применяется термин rapid transit (скоростной городской транспорт), однако употребляется он только тогда, когда по смыслу невозможно ограничиться названием одной конкретной системы метрополитена. <hl> в остальных случаях используются индивидуальные названия: в лондоне — london underground, в нью-йорке — new york subway, в ливерпуле — merseyrail, в вашингтоне — washington metrorail, в сан-франциско — bart и т. п. в некоторых городах применяется название метро (англ. metro) для систем, по своему характеру близких к метро, или для всего городского транспорта (собственно метро и наземный пассажирский транспорт (в том числе автобусы и трамваи)) в совокупности.')
+```
+
+## Evaluation Metrics
+
+
+### Metrics
+
+| Dataset | Type | BLEU4 | ROUGE-L | METEOR | BERTScore | MoverScore | Link |
+|:--------|:-----|------:|--------:|-------:|----------:|-----------:|-----:|
+| [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) | default | 0.18064142309448245 | 0.33780523556447417 | 0.289216348958004 | 0.8628808111702687 | 0.6501855498621383 | [link](https://huggingface.co/lmqg/mt5-small-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-small
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 17
+ - 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/lmqg/mt5-small-ruquad-multitask/raw/main/trainer_config.json).
+
+## Citation
+TBA

trainer_config.json

@@ -1 +1 @@
-{"dataset_path": "asahi417/qg_ruquad", "dataset_name": "default", "input_types": ["paragraph_answer", "paragraph_sentence"], "output_types": ["question", "answer"], "prefix_types": ["qg", "ae"], "model": "google/mt5-small", "max_length": 512, "max_length_output": 32, "epoch": 17, "batch": 16, "lr": 0.001, "fp16": false, "random_seed": 1, "gradient_accumulation_steps": 4, "label_smoothing": 0.15}
+{"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-small", "max_length": 512, "max_length_output": 32, "epoch": 17, "batch": 16, "lr": 0.001, "fp16": false, "random_seed": 1, "gradient_accumulation_steps": 4, "label_smoothing": 0.15}