model update

README.md

@@ -58,14 +58,14 @@ This model is fine-tuned version of [google/mt5-small](https://huggingface.co/go
 [lmqg/qg_esquad](https://huggingface.co/datasets/lmqg/qg_esquad) (dataset_name: default) via [`lmqg`](https://github.com/asahi417/lm-question-generation).
 This model is fine-tuned on the answer extraction task as well as the question generation.
 
-Please cite our paper if you use the model ([TBA](TBA)).
+Please cite our paper if you use the model ([https://arxiv.org/abs/2210.03992](https://arxiv.org/abs/2210.03992)).
 
 ```
 
 @inproceedings{ushio-etal-2022-generative,
-    title = "{G}enerative {L}anguage {M}odels for {P}aragraph-{L}evel {Q}uestion {G}eneration: {A} {U}nified {B}enchmark and {E}valuation",
+    title = "{G}enerative {L}anguage {M}odels for {P}aragraph-{L}evel {Q}uestion {G}eneration",
     author = "Ushio, Asahi  and
-        Alva-Manchego, Fernando and
+        Alva-Manchego, Fernando  and
         Camacho-Collados, Jose",
     booktitle = "Proceedings of the 2022 Conference on Empirical Methods in Natural Language Processing",
     month = dec,
@@ -82,20 +82,29 @@ Please cite our paper if you use the model ([TBA](TBA)).
 - **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:** [TBA](TBA)
+- **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 transformers import pipeline
+from lmqg import TransformersQG
+# initialize model
+model = TransformersQG(language='es', model='lmqg/mt5-small-esquad-multitask')
+# model prediction
+question_answer = model.generate_qa("a noviembre , que es también la estación lluviosa.")
 
-model_path = 'lmqg/mt5-small-esquad-multitask'
-pipe = pipeline("text2text-generation", model_path)
+```
 
-# Answer Extraction
-answer = pipe('extract answers: <hl> En la diáspora somalí, múltiples eventos islámicos de recaudación de fondos se llevan a cabo cada año en ciudades como Birmingham, Londres, Toronto y Minneapolis, donde los académicos y profesionales somalíes dan conferencias y responden preguntas de la audiencia. <hl> El propósito de estos eventos es recaudar dinero para nuevas escuelas o universidades en Somalia, para ayudar a los somalíes que han sufrido como consecuencia de inundaciones y / o sequías, o para reunir fondos para la creación de nuevas mezquitas como.')
+- With `transformers`
+```python
 
-# Question Generation
+from transformers import pipeline
+# initialize model
+pipe = pipeline("text2text-generation", 'lmqg/mt5-small-esquad-multitask')
+# answer extraction
+answer = pipe('extract answers: <hl> En la diáspora somalí, múltiples eventos islámicos de recaudación de fondos se llevan a cabo cada año en ciudades como Birmingham, Londres, Toronto y Minneapolis, donde los académicos y profesionales somalíes dan conferencias y responden preguntas de la audiencia. <hl> El propósito de estos eventos es recaudar dinero para nuevas escuelas o universidades en Somalia, para ayudar a los somalíes que han sufrido como consecuencia de inundaciones y / o sequías, o para reunir fondos para la creación de nuevas mezquitas como.')
+# question generation
 question = pipe('generate question: del <hl> Ministerio de Desarrollo Urbano <hl> , Gobierno de la India.')
 
 ```
@@ -134,11 +143,12 @@ The following hyperparameters were used during fine-tuning:
 The full configuration can be found at [fine-tuning config file](https://huggingface.co/lmqg/mt5-small-esquad-multitask/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: {A} {U}nified {B}enchmark and {E}valuation",
+    title = "{G}enerative {L}anguage {M}odels for {P}aragraph-{L}evel {Q}uestion {G}eneration",
     author = "Ushio, Asahi  and
-        Alva-Manchego, Fernando and
+        Alva-Manchego, Fernando  and
         Camacho-Collados, Jose",
     booktitle = "Proceedings of the 2022 Conference on Empirical Methods in Natural Language Processing",
     month = dec,
@@ -147,3 +157,4 @@ The full configuration can be found at [fine-tuning config file](https://hugging
     publisher = "Association for Computational Linguistics",
 }
 
+```