Update README.md

README.md

@@ -5,29 +5,50 @@ datasets:
 - tquad2
 - xquad 
 tags: 
+- text2text-generation
+- question-generation
 - answer-extraction
 - question-answering
-- question-generation
 - text-generation
-- text2text-generation
+pipeline_tag: text2text-generation
+widget:
+- text: "generate question: Legendary Entertainment, 2016 yılında bilimkurgu romanı Dune'un <hl> film ve TV haklarını <hl> satın aldı. Geliştirme kısa bir süre sonra başladı. Villeneuve projeye olan ilgisini dile getirdi ve resmi olarak yönetmen olarak imza attı. Roth ve Spaihts ile birlikte çalışarak senaryoyu iki bölüme ayırdı ve 1965 romanının 21. yüzyıla güncellenmiş bir uyarlamasını ekledi."
+  example_title: "Question Generation (Movie)"
+- text: "generate question: Fatih Sultan Mehmet, Cenevizlilerin önemli üslerinden Amasra’yı aldı. 1479’da <hl> bir antlaşma yaparak <hl> Venedik'le  16 yıllık savaşa son verdi."
+  example_title: "Question Generation (History)"
+- text: "generate question: Cenevizlilerin önemli üslerinden Amasra’yı aldı. 1479’da bir antlaşma yaparak <hl> Venedik'le <hl> 16 yıllık savaşa sona verdi."
+  example_title: "Question Generation (History 2)"
+- text: "extract answers: Cenevizlilerin önemli üslerinden Amasra’yı aldı. <hl> 1479’da bir antlaşma yaparak Venedik'le 16 yıllık savaşa sona verdi. <hl>"
+  example_title: "Answer Extraction (History)"
+- text: "question: Bu model ne ise yarar? context: Çalışmada sunulan yöntemle, Türkçe metinlerden otomatik olarak soru ve cevap üretilebilir. Bu proje ile paylaşılan kaynak kodu ile Türkçe Soru Üretme / Soru Cevaplama konularında yeni akademik çalışmalar yapılabilir. Projenin detaylarına paylaşılan Github ve Arxiv linklerinden ulaşılabilir."
+  example_title: "Answer Extraction (Open Domain)"
 license: cc-by-4.0
 ---
 
 # mt5-base for Turkish Question Generation
 Automated question generation and question answering using text-to-text transformers by OBSS AI.
-
 ```python
 from core.api import GenerationAPI
-generation_api = GenerationAPI(model_url_or_path='mt5-base-3task-highlight-combined3')
+generation_api = GenerationAPI('mt5-base-3task-highlight-combined3')
 ```
 
-## Overview
-**Language model:** mt5-base 
-**Language:** Turkish
-**Downstream-task:** Extractive QA/QG, Answer Extraction
-**Training data:** TQuADv2-train, TQuADv2-val, XQuAD.tr
-**Code:**  https://github.com/obss/turkish-question-generation
-**Paper:**  https://arxiv.org/abs/2111.06476
+##  Citation 📜
+```
+@article{akyon2021automated,
+  title={Automated question generation and question answering from Turkish texts using text-to-text transformers},
+  author={Akyon, Fatih Cagatay and Cavusoglu, Devrim and Cengiz, Cemil and Altinuc, Sinan Onur and Temizel, Alptekin},
+  journal={arXiv preprint arXiv:2111.06476},
+  year={2021}
+}
+```
+
+## Overview ✔️
+**Language model:** mt5-base  
+**Language:** Turkish  
+**Downstream-task:** Extractive QA/QG, Answer Extraction  
+**Training data:** TQuADv2-train, TQuADv2-val, XQuAD.tr  
+**Code:**  https://github.com/obss/turkish-question-generation  
+**Paper:**  https://arxiv.org/abs/2111.06476  
 
 ## Hyperparameters
 ```
@@ -47,11 +68,12 @@ Refer to [paper](https://arxiv.org/abs/2111.06476).
 ## Usage 🔥
 ```python
 from core.api import GenerationAPI
+
 generation_api = GenerationAPI('mt5-base-3task-highlight-combined3')
 
 context = """
 Bu modelin eğitiminde, Türkçe soru cevap verileri kullanılmıştır.
-Paylaşılan model kullanılarak, Türkçe metinlerden otomatik olarak soru ve cevap
+Çalışmada sunulan yöntemle, Türkçe metinlerden otomatik olarak soru ve cevap
 üretilebilir. Bu proje ile paylaşılan kaynak kodu ile Türkçe Soru Üretme
 / Soru Cevaplama konularında yeni akademik çalışmalar yapılabilir.
 Projenin detaylarına paylaşılan Github ve Arxiv linklerinden ulaşılabilir.
@@ -66,5 +88,4 @@ generation_api(task='question-answering', context=context, question=question)
 
 # b) Answer Extraction
 generation_api(task='answer-extraction', context=context)
-```
-
+```