commit files to HF hub

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:
+- question answering
+widget:
+- text: "question: чем соответствует абсолютная погрешность скорости света ?, context: Наивысшая точность измерений была достигнута в начале 1970-х. В 1975 году XV Генеральная конференция по мерам и весам зафиксировала это положение и рекомендовала считать скорость света, равной 299 792 458 м/с с относительной погрешностью 4•10−9, что соответствует абсолютной погрешности 1,1 м/с. Впоследствии это значение скорости света было положено в основу определения метра в Международной системе единиц (СИ), а сама скорость света стала рассматриваться как фундаментальная физическая постоянная, по определению равная указанному значению точно."
+  example_title: "Question Answering Example 1" 
+- text: "question: Какие начинания предпринял Lloyds в начале 1970-х годов?, context: В начале 1970-х Lloyds начал расширять деятельность на международной арене, для чего был создан Lloyds Bank International. География его деятельности включала ФРГ, Швейцарию, Ближний Восток, Австралию, Канаду и США; к 1978 году Lloyds был представлен в 43 странах. В 1972 году было создано подразделение страхования, а в 1973 году была основана лизинговая компания Lloyds Leasing. В 1979 году банк начал предоставлять услуги ипотечного кредитования (при покупке недвижимости стоимостью от £25 000 до £150 000). В 1982 году начало работу агентство недвижимости Blackhorse Agencies, к 1989 году у него было 563 отделения. В 1986 году сфера деятельности Lloyds Bank PLC ещё больше расширилась с учреждением брокерской конторы и торгового банка Lloyds Merchant Bank. В 1988 году была поглощена страховая компания Abbey Life Group PLC; после объединения с ней всей своей страховой деятельности была образована дочерняя компания Lloyds Abbey Life. В 1995 году Lloyds Bank Plc объединился с TSB Group plc (группой, образованной в 1986 году из четырёх сберегательных банков Trustee Savings Banks) под названием Lloyds TSB Bank plc. В 2000 году за £7 млрд была поглощена шотландская взаимная страховая компания Scottish Widows."
+  example_title: "Question Answering Example 2" 
+model-index:
+- name: vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qa
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_ruquad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Question Answering)
+      type: bleu4_question_answering
+      value: 33.38
+    - name: ROUGE-L (Question Answering)
+      type: rouge_l_question_answering
+      value: 53.78
+    - name: METEOR (Question Answering)
+      type: meteor_question_answering
+      value: 39.66
+    - name: BERTScore (Question Answering)
+      type: bertscore_question_answering
+      value: 95.49
+    - name: MoverScore (Question Answering)
+      type: moverscore_question_answering
+      value: 83.56
+    - name: AnswerF1Score (Question Answering)
+      type: answer_f1_score__question_answering
+      value: 73.46
+    - name: AnswerExactMatch (Question Answering)
+      type: answer_exact_match_question_answering
+      value: 51.69
+---
+
+# Model Card of `vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qa`
+This model is fine-tuned version of [vocabtrimmer/mt5-small-trimmed-ru-5000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-ru-5000) for question answering 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-qa")
+
+# model prediction
+answers = model.answer_q(list_question="чем соответствует абсолютная погрешность скорости света ?", list_context=" Наивысшая точность измерений была достигнута в начале 1970-х. В 1975 году XV Генеральная конференция по мерам и весам зафиксировала это положение и рекомендовала считать скорость света, равной 299 792 458 м/с с относительной погрешностью 4•10−9, что соответствует абсолютной погрешности 1,1 м/с. Впоследствии это значение скорости света было положено в основу определения метра в Международной системе единиц (СИ), а сама скорость света стала рассматриваться как фундаментальная физическая постоянная, по определению равная указанному значению точно.")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qa")
+output = pipe("question: чем соответствует абсолютная погрешность скорости света ?, context: Наивысшая точность измерений была достигнута в начале 1970-х. В 1975 году XV Генеральная конференция по мерам и весам зафиксировала это положение и рекомендовала считать скорость света, равной 299 792 458 м/с с относительной погрешностью 4•10−9, что соответствует абсолютной погрешности 1,1 м/с. Впоследствии это значение скорости света было положено в основу определения метра в Международной системе единиц (СИ), а сама скорость света стала рассматриваться как фундаментальная физическая постоянная, по определению равная указанному значению точно.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Answering)***: [raw metric file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-ru-5000-ruquad-qa/raw/main/eval/metric.first.answer.paragraph_question.answer.lmqg_qg_ruquad.default.json) 
+
+|                  |   Score | Type    | Dataset                                                          |
+|:-----------------|--------:|:--------|:-----------------------------------------------------------------|
+| AnswerExactMatch |   51.69 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| AnswerF1Score    |   73.46 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| BERTScore        |   95.49 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_1           |   49.55 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_2           |   43.7  | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_3           |   38.47 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| Bleu_4           |   33.38 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| METEOR           |   39.66 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| MoverScore       |   83.56 | default | [lmqg/qg_ruquad](https://huggingface.co/datasets/lmqg/qg_ruquad) |
+| ROUGE_L          |   53.78 | 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_question']
+ - output_types: ['answer']
+ - prefix_types: None
+ - model: vocabtrimmer/mt5-small-trimmed-ru-5000
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 22
+ - batch: 32
+ - 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-qa/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_question.answer.lmqg_qg_ruquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.5171455510892503, "Bleu_2": 0.46042407601577195, "Bleu_3": 0.4123330030087977, "Bleu_4": 0.36482203414861714, "METEOR": 0.4020356618466998, "ROUGE_L": 0.5504782277673981, "BERTScore": 0.9576606956548024, "MoverScore": 0.841500503969959, "AnswerF1Score": 74.69660704930612, "AnswerExactMatch": 53.57426528991263}, "test": {"Bleu_1": 0.4954861624981256, "Bleu_2": 0.43704337001731824, "Bleu_3": 0.3847480429137649, "Bleu_4": 0.33384830769002316, "METEOR": 0.3966301987388857, "ROUGE_L": 0.5377739196151254, "BERTScore": 0.9549443041927953, "MoverScore": 0.8356313213470479, "AnswerF1Score": 73.457854308028, "AnswerExactMatch": 51.6878474980143}}