model update

README.md

@@ -0,0 +1,144 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: ru
+datasets:
+- lmqg/qg_ruquad
+pipeline_tag: text2text-generation
+tags:
+- answer extraction
+widget:
+- text: "<hl> в английском языке в нарицательном смысле применяется термин rapid transit (скоростной городской транспорт), однако употребляется он только тогда, когда по смыслу невозможно ограничиться названием одной конкретной системы метрополитена. <hl> в остальных случаях используются индивидуальные названия: в лондоне — london underground, в нью-йорке — new york subway, в ливерпуле — merseyrail, в вашингтоне — washington metrorail, в сан-франциско — bart и т. п. в некоторых городах применяется название метро (англ. metro) для систем, по своему характеру близких к метро, или для всего городского транспорта (собственно метро и наземный пассажирский транспорт (в том числе автобусы и трамваи)) в совокупности."
+  example_title: "Answering Extraction Example 1" 
+- text: "Вопреки ожиданиям, объединение денежных систем республик не привело к уменьшению инфляции. Напротив, закдензнаки стали невероятно быстро обесцениваться, особенно в 1924 году. Для обеспечения денежного рынка приходилось увеличивать эмиссию закдензнаков и выпускать в оборот купюры невероятно больших номиналов. <hl> Так, в период с 1 января по 20 марта 1924 года были введены в оборот купюры достоинством 25 000 000 рублей, затем — 250 000 000 рублей. <hl> И, наконец, в апреле 1924 года были выпущены купюры миллиардного достоинства (в просторечии лимард)."
+  example_title: "Answering Extraction Example 2" 
+model-index:
+- name: lmqg/mt5-small-ruquad-ae
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_ruquad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Answer Extraction)
+      type: bleu4_answer_extraction
+      value: 16.37
+    - name: ROUGE-L (Answer Extraction)
+      type: rouge_l_answer_extraction
+      value: 44.12
+    - name: METEOR (Answer Extraction)
+      type: meteor_answer_extraction
+      value: 34.93
+    - name: BERTScore (Answer Extraction)
+      type: bertscore_answer_extraction
+      value: 80.96
+    - name: MoverScore (Answer Extraction)
+      type: moverscore_answer_extraction
+      value: 68.52
+    - name: AnswerF1Score (Answer Extraction)
+      type: answer_f1_score__answer_extraction
+      value: 56.62
+    - name: AnswerExactMatch (Answer Extraction)
+      type: answer_exact_match_answer_extraction
+      value: 33.0
+---
+
+# Model Card of `lmqg/mt5-small-ruquad-ae`
+This model is fine-tuned version of [google/mt5-small](https://huggingface.co/google/mt5-small) for answer extraction 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:** [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:** [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-small-ruquad-ae")
+
+# model prediction
+answers = model.generate_a("Нелишним будет отметить, что, развивая это направление, Д. И. Менделеев, поначалу априорно выдвинув идею о температуре, при которой высота мениска будет нулевой, в мае 1860 года провёл серию опытов.")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "lmqg/mt5-small-ruquad-ae")
+output = pipe("<hl> в английском языке в нарицательном смысле применяется термин rapid transit (скоростной городской транспорт), однако употребляется он только тогда, когда по смыслу невозможно ограничиться названием одной конкретной системы метрополитена. <hl> в остальных случаях используются индивидуальные названия: в лондоне — london underground, в нью-йорке — new york subway, в ливерпуле — merseyrail, в вашингтоне — washington metrorail, в сан-франциско — bart и т. п. в некоторых городах применяется название метро (англ. metro) для систем, по своему характеру близких к метро, или для всего городского транспорта (собственно метро и наземный пассажирский транспорт (в том числе автобусы и трамваи)) в совокупности.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Answer Extraction)***: [raw metric file](https://huggingface.co/lmqg/mt5-small-ruquad-ae/raw/main/eval/metric.first.answer.paragraph_sentence.answer.lmqg_qg_ruquad.default.json) 
+
+|                  |   Score | Type    | Dataset                                                          |
+|:-----------------|--------:|:--------|:-----------------------------------------------------------------|
+| AnswerExactMatch |   33    | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| AnswerF1Score    |   56.62 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| BERTScore        |   80.96 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_1           |   28.5  | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_2           |   24.12 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_3           |   20.13 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_4           |   16.37 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| METEOR           |   34.93 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| MoverScore       |   68.52 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| ROUGE_L          |   44.12 | 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_sentence']
+ - output_types: ['answer']
+ - prefix_types: None
+ - model: google/mt5-small
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 5
+ - 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-small-ruquad-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/mt5-small-ruquad-ae/best_model",
+  "_name_or_path": "google/mt5-small",
   "add_prefix": false,
   "architectures": [
     "MT5ForConditionalGeneration"

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

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.2964725952014006, "Bleu_2": 0.25222295801428235, "Bleu_3": 0.21201889610896998, "Bleu_4": 0.17377866973615294, "METEOR": 0.3518615179114908, "ROUGE_L": 0.4519750641722111, "BERTScore": 0.8132370763041843, "MoverScore": 0.6876194192502902, "AnswerF1Score": 57.86991482794855, "AnswerExactMatch": 33.33995234312947}, "test": {"Bleu_1": 0.2849848192105911, "Bleu_2": 0.2412186894979628, "Bleu_3": 0.2013156697240972, "Bleu_4": 0.16366320698229822, "METEOR": 0.34925390246451504, "ROUGE_L": 0.4412231622734748, "BERTScore": 0.8095958014451576, "MoverScore": 0.6852455913894092, "AnswerF1Score": 56.619449287170006, "AnswerExactMatch": 33.00238284352661}}

pytorch_model.bin

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:c04110ae0044fc3bfe1794240c58deaa119f1f5a6c92794ae1e165f91c04870e
-size 1200724741
+oid sha256:997aaadd4f8f0d2a8b424e8826499c86b6cd476bde2a5d7f3c939b66478993d1
+size 1200727429

tokenizer.json

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6e6f102e00fd7c0bc8dbaf509bd484bf6a31063f5b496740f90b989b9baa1d1b
-size 16315565
+oid sha256:181462a2ae4f849197563766ad0dde3e9edf7d32d4551b9f476a320205a8aff2
+size 16330813

tokenizer_config.json

@@ -2,7 +2,7 @@
   "additional_special_tokens": null,
   "eos_token": "</s>",
   "extra_ids": 0,
-  "name_or_path": "lmqg_output/mt5-small-ruquad-ae/best_model",
+  "name_or_path": "google/mt5-small",
   "pad_token": "<pad>",
   "sp_model_kwargs": {},
   "special_tokens_map_file": "/home/asahiushio/.cache/huggingface/transformers/685ac0ca8568ec593a48b61b0a3c272beee9bc194a3c7241d15dcadb5f875e53.f76030f3ec1b96a8199b2593390c610e76ca8028ef3d24680000619ffb646276",

trainer_config.json

@@ -0,0 +1 @@
+{"dataset_path": "lmqg/qg_ruquad", "dataset_name": "default", "input_types": ["paragraph_sentence"], "output_types": ["answer"], "prefix_types": null, "model": "google/mt5-small", "max_length": 512, "max_length_output": 32, "epoch": 5, "batch": 32, "lr": 0.001, "fp16": false, "random_seed": 1, "gradient_accumulation_steps": 2, "label_smoothing": 0.15}