commit files to HF hub

README.md

@@ -0,0 +1,144 @@
+
+---
+license: cc-by-4.0
+metrics:
+- bleu4
+- meteor
+- rouge-l
+- bertscore
+- moverscore
+language: es
+datasets:
+- lmqg/qg_esquad
+pipeline_tag: text2text-generation
+tags:
+- question answering
+widget:
+- text: "question: ¿Cuál es la población de Nueva York a partir de 2014?, context: Situada en uno de los mayores puertos naturales del mundo, la ciudad de Nueva York consta de cinco municipios, cada uno de los cuales es un condado separado del estado de Nueva York. Los cinco distritos - Brooklyn, Queens, Manhattan, el Bronx y Staten Island - se consolidaron en una sola ciudad en 1898. Con una población censada estimada en 2014 de 8.491.079 habitantes distribuidos en una superficie de solo 790 km ², Nueva York es la ciudad más densamente poblada de los Estados Unidos. Hasta 800 idiomas se hablan en Nueva York, por lo que es la ciudad más lingüísticamente diversa del mundo. Según estimaciones del censo de 2014, la región metropolitana de la ciudad de Nueva York sigue siendo por un margen significativo la más poblada de los Estados Unidos, según lo definido tanto por el Área Estadística Metropolitana (20,1 millones de residentes). En 2013, el MSA produjo un producto metropolitano bruto (GMP) de casi US $1,39 billones, mientras que en 2012, el CSA generó un GMP de más de US $1,55 billones, ambos clasificados en primer lugar."
+  example_title: "Question Answering Example 1" 
+- text: "question: ¿Cómo se llama el ejército personal de Sassou?, context: El progreso democrático del Congo se descarriló en 1997, cuando Lissouba y Sassou comenzaron a luchar por el poder en la guerra civil. A medida que se acercaban las elecciones presidenciales de julio de 1997, las tensiones entre los campos de Lissouba y Sassou aumentaron. El 5 de junio, las fuerzas del gobierno del presidente Lissouba rodearon el complejo de Sassou en Brazzaville y Sassou ordenó a los miembros de su milicia privada (conocida como Cobras) resistir. Así comenzó un conflicto de cuatro meses que destruyó o dañó gran parte de Brazzaville y causó decenas de miles de muertes civiles. A principios de octubre, el régimen socialista angoleño comenzó una invasión del Congo para instalar a Sassou en el poder. A mediados de octubre, el gobierno de Lissouba cayó. Poco después, Sassou se declaró presidente."
+  example_title: "Question Answering Example 2" 
+model-index:
+- name: vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qa
+  results:
+  - task:
+      name: Text2text Generation
+      type: text2text-generation
+    dataset:
+      name: lmqg/qg_esquad
+      type: default
+      args: default
+    metrics:
+    - name: BLEU4 (Question Answering)
+      type: bleu4_question_answering
+      value: 14.81
+    - name: ROUGE-L (Question Answering)
+      type: rouge_l_question_answering
+      value: 35.33
+    - name: METEOR (Question Answering)
+      type: meteor_question_answering
+      value: 30.92
+    - name: BERTScore (Question Answering)
+      type: bertscore_question_answering
+      value: 90.62
+    - name: MoverScore (Question Answering)
+      type: moverscore_question_answering
+      value: 74.78
+    - name: AnswerF1Score (Question Answering)
+      type: answer_f1_score__question_answering
+      value: 58.12
+    - name: AnswerExactMatch (Question Answering)
+      type: answer_exact_match_question_answering
+      value: 37.52
+---
+
+# Model Card of `vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qa`
+This model is fine-tuned version of [vocabtrimmer/mt5-small-trimmed-es-10000](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-es-10000) for question answering 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-qa")
+
+# model prediction
+answers = model.answer_q(list_question="¿Cuál es la población de Nueva York a partir de 2014?", list_context=" Situada en uno de los mayores puertos naturales del mundo, la ciudad de Nueva York consta de cinco municipios, cada uno de los cuales es un condado separado del estado de Nueva York. Los cinco distritos - Brooklyn, Queens, Manhattan, el Bronx y Staten Island - se consolidaron en una sola ciudad en 1898. Con una población censada estimada en 2014 de 8.491.079 habitantes distribuidos en una superficie de solo 790 km ², Nueva York es la ciudad más densamente poblada de los Estados Unidos. Hasta 800 idiomas se hablan en Nueva York, por lo que es la ciudad más lingüísticamente diversa del mundo. Según estimaciones del censo de 2014, la región metropolitana de la ciudad de Nueva York sigue siendo por un margen significativo la más poblada de los Estados Unidos, según lo definido tanto por el Área Estadística Metropolitana (20,1 millones de residentes). En 2013, el MSA produjo un producto metropolitano bruto (GMP) de casi US $1,39 billones, mientras que en 2012, el CSA generó un GMP de más de US $1,55 billones, ambos clasificados en primer lugar.")
+
+```
+
+- With `transformers`
+```python
+from transformers import pipeline
+
+pipe = pipeline("text2text-generation", "vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qa")
+output = pipe("question: ¿Cuál es la población de Nueva York a partir de 2014?, context: Situada en uno de los mayores puertos naturales del mundo, la ciudad de Nueva York consta de cinco municipios, cada uno de los cuales es un condado separado del estado de Nueva York. Los cinco distritos - Brooklyn, Queens, Manhattan, el Bronx y Staten Island - se consolidaron en una sola ciudad en 1898. Con una población censada estimada en 2014 de 8.491.079 habitantes distribuidos en una superficie de solo 790 km ², Nueva York es la ciudad más densamente poblada de los Estados Unidos. Hasta 800 idiomas se hablan en Nueva York, por lo que es la ciudad más lingüísticamente diversa del mundo. Según estimaciones del censo de 2014, la región metropolitana de la ciudad de Nueva York sigue siendo por un margen significativo la más poblada de los Estados Unidos, según lo definido tanto por el Área Estadística Metropolitana (20,1 millones de residentes). En 2013, el MSA produjo un producto metropolitano bruto (GMP) de casi US $1,39 billones, mientras que en 2012, el CSA generó un GMP de más de US $1,55 billones, ambos clasificados en primer lugar.")
+
+```
+
+## Evaluation
+
+
+- ***Metric (Question Answering)***: [raw metric file](https://huggingface.co/vocabtrimmer/mt5-small-trimmed-es-10000-esquad-qa/raw/main/eval/metric.first.answer.paragraph_question.answer.lmqg_qg_esquad.default.json) 
+
+|                  |   Score | Type    | Dataset                                                          |
+|:-----------------|--------:|:--------|:-----------------------------------------------------------------|
+| AnswerExactMatch |   37.52 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| AnswerF1Score    |   58.12 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| BERTScore        |   90.62 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| Bleu_1           |   24.59 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| Bleu_2           |   20.23 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| Bleu_3           |   17.23 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| Bleu_4           |   14.81 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| METEOR           |   30.92 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| MoverScore       |   74.78 | default | [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) |
+| ROUGE_L          |   35.33 | 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_question']
+ - output_types: ['answer']
+ - prefix_types: None
+ - model: vocabtrimmer/mt5-small-trimmed-es-10000
+ - max_length: 512
+ - max_length_output: 32
+ - epoch: 13
+ - 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-es-10000-esquad-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_esquad.default.json

@@ -0,0 +1 @@
+{"validation": {"Bleu_1": 0.23832833539130593, "Bleu_2": 0.1969207077654796, "Bleu_3": 0.16789890215655737, "Bleu_4": 0.14497652026733496, "METEOR": 0.31347989957682143, "ROUGE_L": 0.35046426863910496, "BERTScore": 0.9026615262539068, "MoverScore": 0.7390983855385427, "AnswerF1Score": 56.76834829494377, "AnswerExactMatch": 35.78051087984863}, "test": {"Bleu_1": 0.2459101532069555, "Bleu_2": 0.20234061544501533, "Bleu_3": 0.17226821433797576, "Bleu_4": 0.14812070784189646, "METEOR": 0.30920168438529005, "ROUGE_L": 0.35334430411915085, "BERTScore": 0.9061520280032758, "MoverScore": 0.7478094570245037, "AnswerF1Score": 58.11686453358094, "AnswerExactMatch": 37.52128666035951}}