Update README.md

README.md

@@ -12,6 +12,11 @@ size_categories:
 
 # ViQP: Dataset for Vietnamese Question Paraphrasing
 
+## Dataset summary
+
+We created a new dataset consisting of pairs of questions, where each pair contains a source question and a paraphrased question. The dataset was constructed by collecting questions from various sources and then paraphrasing them using a team of human annotators. 
+
+## Dataset sample
 An example of 'viqp_train.json' looks as follows.
 ```json
   {
@@ -26,6 +31,30 @@ An example of 'viqp_train.json' looks as follows.
   }
 ```
 
+# Model resource
+
+Question paraphrasing model after training with ViQP is available at [here](https://huggingface.co/SCM-LAB/vietnamese_question_paraphrasing_ViT5_base)
+
+```cmd
+pip install simplet5
+```
+
+```python
+from simplet5 import SimpleT5
+
+model = SimpleT5()
+model.load_model("t5", "SCM-LAB/vietnamese_question_paraphrasing_ViT5_base", use_gpu=True)
+data = "Bài thơ Lượm do ai sáng tác?"
+model.predict(f"question paraphrasing: {data}", num_return_sequences= 5, num_beams= 5)
+
+>>> ['Người sáng tác bài thơ Lượm là ai?',
+ 'Ai là người đã sáng tác bài thơ Lượm?',
+ 'Tác phẩm thơ Lượm do ai sáng tác?',
+ 'Ai là tác giả của bài thơ Lượm?',
+ 'Tác phẩm thơ Lượm được sáng tác bởi ai?']
+
+```
+
 
 # Citation Information
 
@@ -34,7 +63,7 @@ An example of 'viqp_train.json' looks as follows.
   title     = {{ViQP: Dataset for Vietnamese Question Paraphrasing }},
   author    = {Sang Quang Nguyen, Thuc Dinh Vo, Duc Phan-Anh Nguyen, Dang Thanh Tran, Kiet Van Nguyen},
   booktitle = {x},
-  year      = {2020},
+  year      = {2023},
   pages     = {x}
 }
 ```