Update README.md

README.md

@@ -1,4 +1,14 @@
 ---
+language:
+- ku
+- en
+license: cc-by-4.0
+size_categories:
+- 10K<n<100K
+task_categories:
+- text-classification
+- translation
+pretty_name: Kurdish News Dataset Headlines (KNDH)
 dataset_info:
   features:
   - name: label
@@ -20,4 +30,79 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+tags:
+- kurdish
+- translation
+- news
 ---
+# Dataset Card for Kurdish News Dataset Headlines (KNDH)
+
+## Summary
+
+Description from the paper: the Kurdish language belongs to the Indo-Iranian family of Indo-European languages. It is well-known to be a close relative to the Persian language. The speakers span the intersections of Iran, Turkey, Iraq, and Syria. The Kurdish language is one of the official languages in Iraq and has regional status in Iran. The language has 40 million speakers [2,11].
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("nazimali/kurdish-news-headlines-classification", split="train")
+ds
+```
+
+Output:
+
+```python
+Dataset({
+    features: ['label', 'text', 'text-english', 'url'],
+    num_rows: 50000
+})
+```
+
+## Data Cleaning
+
+In the paper they describe the data process in detail. There are 2 versions of the original dataset, list of changes I made:
+
+ - Renamed the original column names so it's easier to read & process
+ - Merged the column `url` from version 1 and columns `label, text, text-english` from version 2
+ - Excluded 2 pre-processed text columns from version 2
+
+## Dataset Sources
+
+- **Paper [Kurdish News Dataset Headlines (KNDH) through Multiclass Classification](https://data.mendeley.com/datasets/kb7vvkg2th/2)**
+
+## Dataset Structure
+
+ - 50,000 rows
+ - 5 unique labels
+     - `sport, health, science & technology, social, economic`
+     - Each label contains 10,000 rows
+
+|        | label   | text               | text-english    | url                                                                     |
+|:-------|:--------|:-------------------|:----------------|:------------------------------------------------------------------------|
+| count  | 50000   | 50000              | 50000           | 48832                                                                   |
+| unique | 5       | 41912              | 41008           | 43891                                                                   |
+
+## Citation
+
+- **Version 1:**
+
+    ```
+    Badawi, Soran;
+    Mohammed, ARI (2022),
+    "Kurdish News Dataset Headlines (KNDH) through Multiclass Classification",
+    Mendeley Data,
+    V1,
+    doi: 10.17632/kb7vvkg2th.1
+    ```
+
+- **Version 2:**
+
+    ```
+    Badawi, Soran;
+    Mohammed, ARI (2023),
+    "Kurdish News Dataset Headlines (KNDH) through Multiclass Classification",
+    Mendeley Data,
+    V2,
+    doi: 10.17632/kb7vvkg2th.2
+    ```