Upload README.md with huggingface_hub

README.md

@@ -25,22 +25,26 @@ size_categories:
 # KenTrans: Kenyan Languages to Swahili Translation Dataset
 
 ## Dataset Structure
-**KenTrans** is a parallel corpus between **Swahili** and three Kenyan languages (with multiple Luhya dialects). The project produced **12,400** sentence pairs translated **into Swahili**:
-
-- **Dholuo → Swahili:** 1,500 pairs  
-- **Luhya → Swahili (total):** 10,900 pairs across three dialects  
-  - **Lumarachi (lch)**  
-  - **Lulogooli (llg)**  
-  - **Lubukusu (lbk)**
-
-Each document contains sentence pairs formatted with a leading label:
-- The **original** (source) sentence line starts with `O:`
-- The **translation** (Swahili) sentence line starts with `T:`
-
-> Example  
-> ```
-> O: OSIEPE MA KENDE
-> T: MARAFIKI WA DHATI
+**KenTrans** is a parallel corpus between **Swahili** and three Kenyan languages (with multiple Luhya dialects). The dataset contains **11,795** sentence pairs translated **into Swahili**:
+
+- **Dholuo → Swahili:** 4,222 pairs
+- **Luhya → Swahili (total):** 7,573 pairs across three dialects
+  - **Lumarachi (lch):** 2,475 pairs
+  - **Lulogooli (llg):** 3,692 pairs
+  - **Lubukusu (lbk):** 1,406 pairs
+
+The dataset is provided in **Parquet format**, which is compatible with Hugging Face `datasets` library version 4.0.0 and above.
+
+Each example contains parallel text with the following fields:
+- **source**: Original sentence in the source language
+- **target**: Translation in Swahili
+
+> Example
+> ```python
+> {
+>   'source': 'OSIEPE MA KENDE',
+>   'target': 'MARAFIKI WA DHATI'
+> }
 > ```
 
 ### Languages & Codes
@@ -55,12 +59,14 @@ Each document contains sentence pairs formatted with a leading label:
 
 ---
 
+## Dataset Format
 
-## Internal Structure (Consistent across all files and folders):
+The dataset is distributed as **Parquet files** for optimal performance and compatibility:
 
-- Files are UTF-8 `.txt`
-- Each file contains **multiple** `O:` / `T:` sentence pairs
-- Sentence pairs are separated by newlines
+- **Format**: Apache Parquet (columnar storage)
+- **Encoding**: UTF-8
+- **File naming**: `{language}-train.parquet` (e.g., `dho-train.parquet`)
+- **Compatibility**: Works with `datasets` 4.0.0+ without custom loading scripts
 
 ---
 
@@ -80,24 +86,37 @@ When parsed into records, each example can be represented with:
 
 ## Usage
 
-### Loading with 🤗 Datasets (example interface)
+### Loading with 🤗 Datasets
+
+**Compatible with datasets 4.0.0+** (No `trust_remote_code` needed!)
 
 ```python
 from datasets import load_dataset
 
 # Load Dholuo → Swahili
-dho = load_dataset("Kencorpus/KenTrans", lang="dho")
+dho = load_dataset("Kencorpus/KenTrans", "dho")
 
 # Load Lubukusu → Swahili
-lbk = load_dataset("Kencorpus/KenTrans", lang="lbk")
+lbk = load_dataset("Kencorpus/KenTrans", "lbk")
 
 # Load Lumarachi → Swahili
-lch = load_dataset("Kencorpus/KenTrans", lang="lch")
+lch = load_dataset("Kencorpus/KenTrans", "lch")
 
 # Load Lulogooli → Swahili
-llg = load_dataset("Kencorpus/KenTrans", lang="llg")
+llg = load_dataset("Kencorpus/KenTrans", "llg")
+
+# Access the data
+print(dho['train'][0])
+# Output: {'id': 'dho_dho_combined.txt_0', 'source': '6AM DALA FM NEWS...', 'target': 'VIDOKEZI VYA HABARI...', ...}
 ```
 
+### Dataset Format
+
+The dataset is stored in **Parquet format** with the following structure:
+- Each language pair has its own Parquet file (e.g., `dho-train.parquet`)
+- Each row represents a parallel sentence pair
+- All metadata is included in the Parquet schema
+
 
 
 ## Sources