Update README.md

README.md

@@ -1,4 +1,34 @@
+---
+name: Persian Poetry QA Dataset
+description: |
+    This dataset is structured in a question-answering format derived from a rich collection of Persian poems along with metadata about the poets and the verses. 
+    It is designed to be utilized for various Natural Language Processing and analysis tasks related to Persian poetry, such as Question Answering, Text Generation, Language Modeling, and Style Analysis.
+license: gpl-2.0
+url: https://github.com/ganjoor/desktop/releases/tag/v2.81
+citation: |
+    Persian Poetry QA Dataset. Collected by Kakooch from the Ganjoor Project.
+    Available at: https://huggingface.co/datasets/persian_poetry
+size: "Custom"
+language: 
+    - fa
+splits:
+    train:
+        description: "This split contains Persian poems structured for QA, where each row asks for a sample poem from a specific poet with the poem or verse as the answer."
+features:
+    context:
+        description: "A static string which is 'Persian Poetry or شعر فارسی'."
+        type: "string"
+    question:
+        description: "A string that asks for a sample poem from a specific poet in the format 'یک نمونه از شعر [POET_NAME]'."
+        type: "string"
+    answer:
+        description: "Text of a hemistich or verse."
+        type: "string"
+    answer_start:
+        description: "The starting character index of `answer` within `context` (Note: this is always -1 in the current dataset as `answer` is not a substring of `context`)."
+        type: "int32"
 
+---
 # Persian Poetry Dataset
 
 ## Dataset Description
@@ -45,7 +75,7 @@ This dataset can be utilized for various Natural Language Processing and analysi
 
 ### License
 
-GPL (GNU General Public License)
+GPL-2 (GNU General Public License) ingerited from original ganjoor project 
 
 ## Additional Information