Everlyn commited on
Commit
d24fc54
·
verified ·
1 Parent(s): bc9938b

Update README.md

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