Everlyn commited on
Commit
ff228b3
·
verified ·
1 Parent(s): d1c3b07

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +168 -168
README.md CHANGED
@@ -1,168 +1,168 @@
1
- ---
2
- language:
3
- - luo
4
- - bxk
5
- - lri
6
- - rag
7
- - swa
8
- license: cc-by-4.0
9
- task_categories:
10
- - translation
11
- tags:
12
- - kenyan-languages
13
- - dholuo
14
- - lubukusu
15
- - lumarachi
16
- - lulogooli
17
- - swahili
18
- - low-resource-languages
19
- - african-languages
20
- pretty_name: KenTrans
21
- size_categories:
22
- - 10K<n<100K
23
- ---
24
-
25
- # KenTrans: Kenyan Languages to Swahili Translation Dataset
26
-
27
- ## Dataset Structure
28
- **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**:
29
-
30
- - **Dholuo → Swahili:** 4,222 pairs
31
- - **Luhya → Swahili (total):** 7,573 pairs across three dialects
32
- - **Lumarachi (lch):** 2,475 pairs
33
- - **Lulogooli (llg):** 3,692 pairs
34
- - **Lubukusu (lbk):** 1,406 pairs
35
-
36
- The dataset is provided in **Parquet format**, which is compatible with Hugging Face `datasets` library version 4.0.0 and above.
37
-
38
- Each example contains parallel text with the following fields:
39
- - **source**: Original sentence in the source language
40
- - **target**: Translation in Swahili
41
-
42
- > Example
43
- > ```python
44
- > {
45
- > 'source': 'OSIEPE MA KENDE',
46
- > 'target': 'MARAFIKI WA DHATI'
47
- > }
48
- > ```
49
-
50
- ### Languages & Codes
51
-
52
- | Language / Dialect | Code | Family / Notes |
53
- |--------------------|------|-------------------------------|
54
- | Dholuo (Luo) | dho | Nilotic (western Kenya) |
55
- | Lubukusu (Bukusu) | lbk | Bantu, Luhya dialect |
56
- | Lumarachi (Marachi)| lch | Bantu, Luhya dialect |
57
- | Lulogooli (Logooli)| llg | Bantu, Luhya dialect |
58
- | Swahili | swa | Target language for all pairs |
59
-
60
- ---
61
-
62
- ## Dataset Format
63
-
64
- The dataset is distributed as **Parquet files** for optimal performance and compatibility:
65
-
66
- - **Format**: Apache Parquet (columnar storage)
67
- - **Encoding**: UTF-8
68
- - **File naming**: `{language}-train.parquet` (e.g., `dho-train.parquet`)
69
- - **Compatibility**: Works with `datasets` 4.0.0+ without custom loading scripts
70
-
71
- ---
72
-
73
- ## Data Fields (Programmatic View)
74
-
75
- When parsed into records, each example can be represented with:
76
-
77
- - `id`: Unique identifier (e.g., `dho_0773_dho_tr.txt_0`)
78
- - `source`: Source language sentence
79
- - `target`: Target Swahili sentence
80
- - `src_lang`: One of `dho`, `lbk`, `lch`, `llg`
81
- - `tgt_lang`: Always `swa`
82
- - `pair`: Language pair as `"{src}-{tgt}"` (e.g., `dho-swa`)
83
- - `filename`: Source filename (e.g., `0773_dho_tr.txt`)
84
-
85
- ---
86
-
87
- ## Usage
88
-
89
- ### Loading with 🤗 Datasets
90
-
91
- **Compatible with datasets 4.0.0+** (No `trust_remote_code` needed!)
92
-
93
- ```python
94
- from datasets import load_dataset
95
-
96
- # Load Dholuo → Swahili
97
- dho = load_dataset("Kencorpus/KenTrans", "dho")
98
-
99
- # Load Lubukusu → Swahili
100
- lbk = load_dataset("Kencorpus/KenTrans", "lbk")
101
-
102
- # Load Lumarachi → Swahili
103
- lch = load_dataset("Kencorpus/KenTrans", "lch")
104
-
105
- # Load Lulogooli → Swahili
106
- llg = load_dataset("Kencorpus/KenTrans", "llg")
107
-
108
- # Access the data
109
- print(dho['train'][0])
110
- # Output: {'id': 'dho_dho_combined.txt_0', 'source': '6AM DALA FM NEWS...', 'target': 'VIDOKEZI VYA HABARI...', ...}
111
- ```
112
-
113
- ### Dataset Format
114
-
115
- The dataset is stored in **Parquet format** with the following structure:
116
- - Each language pair has its own Parquet file (e.g., `dho-train.parquet`)
117
- - Each row represents a parallel sentence pair
118
- - All metadata is included in the Parquet schema
119
-
120
-
121
-
122
- ## Sources
123
-
124
- ## Translators (Acknowledgements)
125
- **Dholuo → Swahili**
126
- - Mercy Lavinca Oduoll (Coordinator)
127
- - Bildad Okebe
128
- - Immaculate Ochieng
129
- - Mary Muma.
130
-
131
- **Luhya (Logooli) → Swahili**
132
- - Phillip Lumwamu (Coordinator)
133
- - Kints Mugoha Musungu
134
- - Vivian Alivitsa
135
- - Joseph Ambwere
136
- - Joyline Ingasiani.
137
-
138
- **Luhya (Bukusu) → Swahili**
139
- - Martin Barasa Mulwale (Coordinator)
140
- - Samwel Ralph Nyongesa
141
- - Tobias Shikuku
142
- - Phelisters N Simiyu
143
-
144
- **Luhya (Marachi) → Swahili**
145
- - Judith Awinja (Coordinator)
146
- - Evans Owino
147
- - Belinda Oduor
148
- - Frankline Mwaro
149
-
150
-
151
-
152
-
153
- ## Dataset Curator
154
- - Indede, Florence (Maseno University)
155
- - McOnyango, Owen (Maseno University)
156
- - Wanzare, Lilian D.A. (Maseno University)
157
- - Wanjawa, Barack (University of Nairobi)
158
- - Ombui, Edward (Africa Nazarene University)
159
- - Muchemi, Lawrence (University of Nairobi)
160
-
161
- ## Research Paper
162
-
163
- - 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. https://arxiv.org/abs/2208.12081
164
-
165
- ## Links
166
- Dataverse: https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/KLCKL5
167
-
168
-
 
1
+ ---
2
+ language:
3
+ - luo
4
+ - bxk
5
+ - lri
6
+ - rag
7
+ - swa
8
+ license: cc-by-4.0
9
+ task_categories:
10
+ - translation
11
+ tags:
12
+ - kenyan-languages
13
+ - dholuo
14
+ - lubukusu
15
+ - lumarachi
16
+ - lulogooli
17
+ - swahili
18
+ - low-resource-languages
19
+ - african-languages
20
+ pretty_name: KenTrans
21
+ size_categories:
22
+ - 10K<n<100K
23
+ ---
24
+
25
+ # KenTrans: Kenyan Languages to Swahili Translation Dataset
26
+
27
+ ## Dataset Structure
28
+ **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**:
29
+
30
+ - **Dholuo → Swahili:** 4,222 pairs
31
+ - **Luhya → Swahili (total):** 7,573 pairs across three dialects
32
+ - **Lumarachi (lch):** 2,475 pairs
33
+ - **Lulogooli (llg):** 3,692 pairs
34
+ - **Lubukusu (lbk):** 1,406 pairs
35
+
36
+ The dataset is provided in **Parquet format**, which is compatible with Hugging Face `datasets` library version 4.0.0 and above.
37
+
38
+ Each example contains parallel text with the following fields:
39
+ - **source**: Original sentence in the source language
40
+ - **target**: Translation in Swahili
41
+
42
+ > Example
43
+ > ```python
44
+ > {
45
+ > 'source': 'OSIEPE MA KENDE',
46
+ > 'target': 'MARAFIKI WA DHATI'
47
+ > }
48
+ > ```
49
+
50
+ ### Languages & Codes
51
+
52
+ | Language / Dialect | Code | Family / Notes |
53
+ |--------------------|------|-------------------------------|
54
+ | Dholuo (Luo) | dho | Nilotic (western Kenya) |
55
+ | Lubukusu (Bukusu) | lbk | Bantu, Luhya dialect |
56
+ | Lumarachi (Marachi)| lch | Bantu, Luhya dialect |
57
+ | Lulogooli (Logooli)| llg | Bantu, Luhya dialect |
58
+ | Swahili | swa | Target language for all pairs |
59
+
60
+ ---
61
+
62
+ ## Dataset Format
63
+
64
+ The dataset is distributed as **Parquet files** for optimal performance and compatibility:
65
+
66
+ - **Format**: Apache Parquet (columnar storage)
67
+ - **Encoding**: UTF-8
68
+ - **File naming**: `{language}-train.parquet` (e.g., `dho-train.parquet`)
69
+ - **Compatibility**: Works with `datasets` 4.0.0+ without custom loading scripts
70
+
71
+ ---
72
+
73
+ ## Data Fields (Programmatic View)
74
+
75
+ When parsed into records, each example can be represented with:
76
+
77
+ - `id`: Unique identifier (e.g., `dho_0773_dho_tr.txt_0`)
78
+ - `source`: Source language sentence
79
+ - `target`: Target Swahili sentence
80
+ - `src_lang`: One of `dho`, `lbk`, `lch`, `llg`
81
+ - `tgt_lang`: Always `swa`
82
+ - `pair`: Language pair as `"{src}-{tgt}"` (e.g., `dho-swa`)
83
+ - `filename`: Source filename (e.g., `0773_dho_tr.txt`)
84
+
85
+ ---
86
+
87
+ ## Usage
88
+
89
+ ### Loading with 🤗 Datasets
90
+
91
+ **Compatible with datasets 4.0.0+** (No `trust_remote_code` needed!)
92
+
93
+ ```python
94
+ from datasets import load_dataset
95
+
96
+ # Load Dholuo → Swahili
97
+ dho = load_dataset("Kencorpus/KenTrans", lang="dho")
98
+
99
+ # Load Lubukusu → Swahili
100
+ lbk = load_dataset("Kencorpus/KenTrans", lang="lbk")
101
+
102
+ # Load Lumarachi → Swahili
103
+ lch = load_dataset("Kencorpus/KenTrans", lang="lch")
104
+
105
+ # Load Lulogooli → Swahili
106
+ llg = load_dataset("Kencorpus/KenTrans", lang="llg")
107
+
108
+ # Access the data
109
+ print(dho['train'][0])
110
+ # Output: {'id': 'dho_dho_combined.txt_0', 'source': '6AM DALA FM NEWS...', 'target': 'VIDOKEZI VYA HABARI...', ...}
111
+ ```
112
+
113
+ ### Dataset Format
114
+
115
+ The dataset is stored in **Parquet format** with the following structure:
116
+ - Each language pair has its own Parquet file (e.g., `dho-train.parquet`)
117
+ - Each row represents a parallel sentence pair
118
+ - All metadata is included in the Parquet schema
119
+
120
+
121
+
122
+ ## Sources
123
+
124
+ ## Translators (Acknowledgements)
125
+ **Dholuo → Swahili**
126
+ - Mercy Lavinca Oduoll (Coordinator)
127
+ - Bildad Okebe
128
+ - Immaculate Ochieng
129
+ - Mary Muma.
130
+
131
+ **Luhya (Logooli) → Swahili**
132
+ - Phillip Lumwamu (Coordinator)
133
+ - Kints Mugoha Musungu
134
+ - Vivian Alivitsa
135
+ - Joseph Ambwere
136
+ - Joyline Ingasiani.
137
+
138
+ **Luhya (Bukusu) → Swahili**
139
+ - Martin Barasa Mulwale (Coordinator)
140
+ - Samwel Ralph Nyongesa
141
+ - Tobias Shikuku
142
+ - Phelisters N Simiyu
143
+
144
+ **Luhya (Marachi) → Swahili**
145
+ - Judith Awinja (Coordinator)
146
+ - Evans Owino
147
+ - Belinda Oduor
148
+ - Frankline Mwaro
149
+
150
+
151
+
152
+
153
+ ## Dataset Curator
154
+ - Indede, Florence (Maseno University)
155
+ - McOnyango, Owen (Maseno University)
156
+ - Wanzare, Lilian D.A. (Maseno University)
157
+ - Wanjawa, Barack (University of Nairobi)
158
+ - Ombui, Edward (Africa Nazarene University)
159
+ - Muchemi, Lawrence (University of Nairobi)
160
+
161
+ ## Research Paper
162
+
163
+ - 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. https://arxiv.org/abs/2208.12081
164
+
165
+ ## Links
166
+ Dataverse: https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/KLCKL5
167
+
168
+