commit files to HF hub

README.md

@@ -0,0 +1,138 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: es
+datasets:
+- lmqg/qg_esquad
+pipeline_tag: text2text-generation
+tags:
+- question generation
+widget:
+- text: "del <hl> Ministerio de Desarrollo Urbano <hl> , Gobierno de la India."
+  example_title: "Question Generation Example 1" 
+- text: "a <hl> noviembre <hl> , que es también la estación lluviosa."
+  example_title: "Question Generation Example 2" 
+- text: "como <hl> el gobierno de Abbott <hl> que asumió el cargo el 18 de septiembre de 2013."
+  example_title: "Question Generation Example 3" 
+model-index:
+- name: vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qg
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_esquad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Question Generation)
+      type: bleu4_question_generation
+      value: 9.33
+    - name: ROUGE-L (Question Generation)
+      type: rouge_l_question_generation
+      value: 23.68
+    - name: METEOR (Question Generation)
+      type: meteor_question_generation
+      value: 21.95
+    - name: BERTScore (Question Generation)
+      type: bertscore_question_generation
+      value: 83.89
+    - name: MoverScore (Question Generation)
+      type: moverscore_question_generation
+      value: 58.72
+---
+
+# Model Card of `vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qg`
+This model is fine-tuned version of [vocabtrimmer/mt5-small-trimmed-es-10000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-es-10000) for question generation task on the [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
+
+
+### Overview
+- **Language model:** [vocabtrimmer/mt5-small-trimmed-es-10000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-es-10000)   
+- **Language:** es  
+- **Training data:** [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) (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="es", model="vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qg")
+
+# model prediction
+questions = model.generate_q(list_context="a noviembre , que es también la estación lluviosa.", list_answer="noviembre")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qg")
+output = pipe("del <hl> Ministerio de Desarrollo Urbano <hl> , Gobierno de la India.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Generation)***: [raw metric file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qg/raw/main/eval/metric.first.sentence.paragraph_answer.question.lmqg_qg_esquad.default.json) 
+
+|            |   Score | Type    | Dataset                                                          |
+|:-----------|--------:|:--------|:-----------------------------------------------------------------|
+| BERTScore  |   83.89 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| Bleu_1     |   25.57 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| Bleu_2     |   17.32 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| Bleu_3     |   12.5  | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| Bleu_4     |    9.33 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| METEOR     |   21.95 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| MoverScore |   58.72 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| ROUGE_L    |   23.68 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+
+
+
+## Training hyperparameters
+
+The following hyperparameters were used during fine-tuning:
+ - dataset_path: lmqg/qg_esquad
+ - dataset_name: default
+ - input_types: paragraph_answer
+ - output_types: question
+ - prefix_types: None
+ - model: vocabtrimmer/mt5-small-trimmed-es-10000
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 10
+ - 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-es-10000-esquad-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_esquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.25497362312723987, "Bleu_2": 0.17219930834469246, "Bleu_3": 0.12475805932445719, "Bleu_4": 0.09328738165084342}, "test": {"Bleu_1": 0.2547425005833578, "Bleu_2": 0.17249862930154575, "Bleu_3": 0.12455966669256617, "Bleu_4": 0.09293226222498961}}

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

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.26704964737751374, "Bleu_2": 0.1818354325458266, "Bleu_3": 0.132411838271594, "Bleu_4": 0.09935073508075266, "METEOR": 0.22184349907401424, "ROUGE_L": 0.24304242700326897, "BERTScore": 0.8367837003959435, "MoverScore": 0.5846949284146059}, "test": {"Bleu_1": 0.2557428329270295, "Bleu_2": 0.17315834397494712, "Bleu_3": 0.125015894041815, "Bleu_4": 0.0932790181624794, "METEOR": 0.21947764064623454, "ROUGE_L": 0.23677687367380187, "BERTScore": 0.8388929192133179, "MoverScore": 0.5872072169345751}}