Add description to README.md

README.md

@@ -1,4 +1,14 @@
 ---
+license: cc-by-sa-4.0
+task_categories:
+- text-retrieval
+task_ids:
+- document-retrieval
+language:
+- kk
+source_datasets:
+- extended|natural_questions|wikipedia
+pretty_name: KazQAD-Retrieval
 configs:
 - config_name: queries-and-passages
   data_files:
@@ -11,4 +21,89 @@ configs:
   default: true
 - config_name: corpus
   data_files: "corpus/kazqad-corpus-v1.0-kk.jsonl.gz"
----
+---
+
+# Dataset Card for KazQAD-Retrieval
+
+## Dataset Description
+
+- **Homepage:** [https://github.com/IS2AI/KazQAD](https://github.com/IS2AI/KazQAD)
+
+### Dataset Summary
+
+**KazQAD** is a **Kaz**akh open-domain **Q**uestion **A**nswering **D**ataset
+that can be used in both reading comprehension and full ODQA settings, as well as for information retrieval experiments.
+This repository contains only the collection and relevance judgments for information retrieval task.
+Short answers and data for the reading comprehension task (extractive QA) can be found [here](https://huggingface.co/datasets/issai/kazqad).
+
+KazQAD contains just under 6,000 unique questions and nearly 12,000 passage-level relevance judgements (subset `queries-and-passages`).
+The questions come from two sources: translated items from the Natural Questions (NQ) dataset (only for training) and 
+the original Kazakh Unified National Testing (UNT) exam (for development and testing).
+
+The accompanying text corpus (subset `corpus`) contains more than 800,000 passages from the Kazakh Wikipedia.
+
+IR format data (topics and qrels) can be found in our [Github repository](https://github.com/IS2AI/KazQAD).
+
+## Dataset Structure
+
+### Data Instances
+
+An example of passage-level relevance judgements (subset `queries-and-passages`) looks as follows.
+
+```
+{
+    "id": "kzh2998kzh",
+    "question": "Ғұндардың ру көсемдері кім болды?",
+    "positive_passages": [
+      {
+        "docid": "101241_28_1",
+        "title": "Көшпелілердегі қоғамдық қатынастар",
+        "text": "Хан билігі бүкіл елге қатысты жоғары саяси билік болса, ру, тайпа көлеміндегі нақты билік сол рулардан шыққан беделді ру ақсақалдарының қолында болды..."
+      },
+    ]
+    "negative_passages": [
+      {
+        "docid": "101241_24_1",
+        "title": "Көшпелілердегі қоғамдық қатынастар",
+        "text": "Қазақ хандарының жанында ақылшысы, кеңесшілері, төбе билері, жасақтары, іс жүргізуші мемлекеттік қызметкерлері болды..."
+      },
+      {
+        "docid": "79445_3_1",
+        "title": "Ежелгі герман тайпалары және рим империясы",
+        "text": "...Германдық тайпалардың негізгі шаруашылық ұясы қауым болды. Қауым мүшелері топқа бөлінбей, жерді бірлесіп өңдеді..."
+      },
+    ]
+}
+```
+
+An example of Kazakh Wikipedia collection (subset `corpus`) looks as follows.
+
+```
+{
+  "docid": "101241_28_1",
+  "title": "Көшпелілердегі қоғамдық қатынастар",
+  "text": "Хан билігі бүкіл елге қатысты жоғары саяси билік болса, ру, тайпа көлеміндегі нақты билік сол рулардан шыққан беделді ру ақсақалдарының қолында болды..."
+}
+```
+
+
+### Data Splits
+
+The following table shows the number of queries (#Q), the number of positive (#P+) and negative (#P-) passages for each data split.
+
+|    **split**   | **#Q** | **#P+** | **#P-** |
+|:--------------:|:------:|:-------:|:-------:|
+|    **train**   |  3,487 |  3,893  |  3,558  |
+| **validation** |   548  |   769   |   229   |
+|    **test**    |  1,929 |  2,718  |   653   |
+
+
+## Citation Information
+```
+@article{kazqad,
+       author = {Rustem Yeshpanov, Pavel Efimov, Leonid Boytsov, Ardak Shalkarbayuli and Pavel Braslavski},
+        title = "{{KazQAD}: Kazakh Open-Domain Question Answering Dataset}",
+      journal = {},
+         year = 2024,
+}
+```