Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,123 @@
+
+# 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
+> ```
+
+### Languages & Codes
+
+| Language / Dialect | Code | Family / Notes                |
+|--------------------|------|-------------------------------|
+| Dholuo (Luo)       | dho  | Nilotic (western Kenya)       |
+| Lubukusu (Bukusu)  | lbk  | Bantu, Luhya dialect          |
+| Lumarachi (Marachi)| lch  | Bantu, Luhya dialect          |
+| Lulogooli (Logooli)| llg  | Bantu, Luhya dialect          |
+| Swahili            | swa  | Target language for all pairs |
+
 ---
-license: cc-by-4.0
+
+
+## Internal Structure (Consistent across all files and folders):
+
+- Files are UTF-8 `.txt`
+- Each file contains **multiple** `O:` / `T:` sentence pairs
+- Sentence pairs are separated by newlines
+
 ---
+
+## Data Fields (Programmatic View)
+
+When parsed into records, each example can be represented with:
+
+- `id`: Unique identifier (e.g., `dho_0773_dho_tr.txt_0`)
+- `source`: Source language sentence
+- `target`: Target Swahili sentence
+- `src_lang`: One of `dho`, `lbk`, `lch`, `llg`
+- `tgt_lang`: Always `swa`
+- `pair`: Language pair as `"{src}-{tgt}"` (e.g., `dho-swa`)
+- `filename`: Source filename (e.g., `0773_dho_tr.txt`)
+
+---
+
+## Usage
+
+### Loading with 🤗 Datasets (example interface)
+
+```python
+from datasets import load_dataset
+
+# Load Dholuo → Swahili
+dho = load_dataset("USERNAME/REPO_NAME", lang="dho")
+
+# Load Lubukusu → Swahili
+lbk = load_dataset("USERNAME/REPO_NAME", lang="lbk")
+
+# Load Lumarachi → Swahili
+lch = load_dataset("USERNAME/REPO_NAME", lang="lch")
+
+# Load Lulogooli → Swahili
+llg = load_dataset("USERNAME/REPO_NAME", lang="llg")
+```
+
+
+
+## Sources
+
+## Translators (Acknowledgements)
+**Dholuo → Swahili**
+- Mercy Lavinca Oduoll (Coordinator)
+- Bildad Okebe
+- Immaculate Ochieng
+- Mary Muma
+**Luhya (Logooli) → Swahili**
+- Phillip Lumwamu (Coordinator)
+- Kints Mugoha Musungu
+- Vivian Alivitsa
+- Joseph Ambwere
+- Joyline Ingasiani
+**Luhya (Bukusu) → Swahili**
+- Martin Barasa Mulwale (Coordinator)
+- Samwel Ralph Nyongesa
+- Tobias Shikuku
+- Phelisters N Simiyu
+**Luhya (Marachi) → Swahili**
+- Judith Awinja (Coordinator)
+- Evans Owino
+- Belinda Oduor
+- Frankline Mwaro
+
+
+
+
+## Dataset Curator
+- Indede, Florence (Maseno University)
+- McOnyango, Owen (Maseno University)
+- Wanzare, Lilian D.A. (Maseno University)
+- Wanjawa, Barack (University of Nairobi)
+- Ombui, Edward (Africa Nazarene University)
+- Muchemi, Lawrence (University of Nairobi)
+
+## Research Paper
+- https://arxiv.org/abs/2208.12081
+- Wanjawa, B.W., Wanzare, L.D., Indede, F., McOnyango, O., Ombui, E., & Muchemi, L. (2022). Kencorpus: A Kenyan Language Corpus of Swahili, Dholuo and Luhya for Natural Language Processing Tasks. ArXiv, abs/2208.12081.
+
+## Links
+Dataverse: https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/KLCKL5
+
+