kargaranamir commited on
Commit
84f5a83
1 Parent(s): b6c421b

add nalibali readme.

Browse files
Files changed (1) hide show
  1. README.md +63 -24
README.md CHANGED
@@ -185,56 +185,86 @@ tags:
185
  - book
186
  - story
187
  - language-identification
188
-
 
189
  configs:
190
- - config_name: default
191
- data_files:
192
- - split: train
193
- path: GlotStoryBook.csv
194
- - config_name: nalibali
195
- data_files:
196
- - split: train
197
- path: nalibali.csv
198
-
 
 
 
 
199
  ---
200
 
201
  ## Dataset Description
202
 
203
- Story Books for 180 ISO-639-3 codes.
204
- A Machine Translation (MT) version of this dataset is also provided in [cis-lmu/GlotStoryBook-MT](https://huggingface.co/datasets/cis-lmu/GlotStoryBook-MT).
 
 
205
 
206
- This dataset consisted of 4 publishers:
207
- 1. asp: [African Storybook](https://africanstorybook.org)
208
- 2. pb: [Pratham Books](https://prathambooks.org/)
209
- 3. lcb: [Little Cree Books](http://littlecreebooks.com/)
210
- 4. lida: [LIDA Stories](https://lidastories.net/)
211
 
 
 
 
 
 
212
 
213
- - **GitHub Repository:** [github](https://github.com/cisnlp/GlotStoryBook)
214
- - **Paper:** [paper](https://arxiv.org/abs/2310.16248)
215
- - **Point of Contact:** [email protected]
216
 
217
 
218
  ## Usage (HF Loader)
 
 
 
219
  ```python
220
  from datasets import load_dataset
221
- dataset = load_dataset('cis-lmu/GlotStoryBook')
222
- print(dataset['train'][0]) # First row data
223
  ```
224
 
 
 
 
 
 
 
 
 
 
225
  ## Download
226
  If you are not a fan of the HF dataloader, download it directly:
227
 
 
 
228
  ```python
229
  ! wget https://huggingface.co/datasets/cis-lmu/GlotStoryBook/resolve/main/GlotStoryBook.csv
230
  ```
231
 
 
 
 
 
 
 
232
  # Tools
233
 
234
  To compute the script of each text we used Glotscript ([code](https://github.com/cisnlp/GlotScript) and [paper](https://arxiv.org/abs/2309.13320)).
235
 
236
 
237
  ## License and Copyright
 
 
 
238
  We do not own any of the text from which these data has been extracted.
239
  All the files are collected from the repository located at https://github.com/global-asp/.
240
  The source repository for each text and file is stored in the dataset.
@@ -242,14 +272,23 @@ Each file in the dataset is associated with one license from the CC family.
242
  The licenses include 'CC BY', 'CC BY-NC', 'CC BY-NC-SA', 'CC-BY', 'CC-BY-NC', and 'Public Domain'.
243
  We also license the code, actual packaging and the metadata of these data under the cc0-1.0.
244
 
 
 
 
 
 
 
 
 
245
  ## Github
246
  We additionally provide a GitHub version that openly shares the source code for processing this dataset:
247
  https://github.com/cisnlp/GlotStoryBook
248
 
249
 
 
250
  ## Citation
251
- If you use any part of this code and data in your research, please cite it (along with https://github.com/global-asp/) using the following BibTeX entry.
252
- This work is part of the [GlotLID](https://github.com/cisnlp/GlotLID) project.
253
 
254
  ```
255
  @inproceedings{
 
185
  - book
186
  - story
187
  - language-identification
188
+ - nalibali
189
+ - machine-translation
190
  configs:
191
+ - config_name: default
192
+ data_files:
193
+ - split: train
194
+ path: GlotStoryBook.csv
195
+ - config_name: nalibali
196
+ data_files:
197
+ - split: train
198
+ path: nalibali.csv
199
+ task_categories:
200
+ - translation
201
+ - text-generation
202
+ - text2text-generation
203
+ - summarization
204
  ---
205
 
206
  ## Dataset Description
207
 
208
+ Story Books for 180 ISO-639-3 codes.
209
+
210
+ The `Parallel ID` or `parallel_id` can be used to find the parallel documents in different languages and build a parallel dataset.
211
+
212
 
213
+ This dataset consists of 2 subsets:
 
 
 
 
214
 
215
+ - **default**, which consists of 4 publishers:
216
+ 1. asp: [African Storybook](https://africanstorybook.org)
217
+ 2. pb: [Pratham Books](https://prathambooks.org/)
218
+ 3. lcb: [Little Cree Books](http://littlecreebooks.com/)
219
+ 4. lida: [LIDA Stories](https://lidastories.net/)
220
 
221
+
222
+ - **nalibali**, which comes from [Nal'ibali](https://nalibali.org/story-resources/multilingual-stories) stories.
 
223
 
224
 
225
  ## Usage (HF Loader)
226
+
227
+ - default:
228
+
229
  ```python
230
  from datasets import load_dataset
231
+ dataset = load_dataset('cis-lmu/GlotStoryBook', 'default', split='train')
232
+ print(dataset[0]) # First row of default data
233
  ```
234
 
235
+ - nalibali:
236
+
237
+ ```python
238
+ from datasets import load_dataset
239
+ dataset = load_dataset('cis-lmu/GlotStoryBook', 'nalibali', split='train')
240
+ print(dataset[0]) # First row of nalibali data
241
+ ```
242
+
243
+
244
  ## Download
245
  If you are not a fan of the HF dataloader, download it directly:
246
 
247
+ - default:
248
+
249
  ```python
250
  ! wget https://huggingface.co/datasets/cis-lmu/GlotStoryBook/resolve/main/GlotStoryBook.csv
251
  ```
252
 
253
+ - nalibali:
254
+
255
+ ```python
256
+ ! wget https://huggingface.co/datasets/cis-lmu/GlotStoryBook/resolve/main/nalibali.csv
257
+ ```
258
+
259
  # Tools
260
 
261
  To compute the script of each text we used Glotscript ([code](https://github.com/cisnlp/GlotScript) and [paper](https://arxiv.org/abs/2309.13320)).
262
 
263
 
264
  ## License and Copyright
265
+
266
+ - default:
267
+
268
  We do not own any of the text from which these data has been extracted.
269
  All the files are collected from the repository located at https://github.com/global-asp/.
270
  The source repository for each text and file is stored in the dataset.
 
272
  The licenses include 'CC BY', 'CC BY-NC', 'CC BY-NC-SA', 'CC-BY', 'CC-BY-NC', and 'Public Domain'.
273
  We also license the code, actual packaging and the metadata of these data under the cc0-1.0.
274
 
275
+
276
+ - nalibali:
277
+
278
+ We do not own any of the text from which these data has been extracted.
279
+ All the files are collected from [https://nalibali.org](https://nalibali.org/story-resources/multilingual-stories) under the [nalibali term of use](https://nalibali.org/terms-use):
280
+ > Material on this website may be freely downloaded, shared and reprinted. In fact, we welcome the circulation and sharing of Nal’ibali resources, provided it adheres to the following guidelines: It is credited to the Nal’ibali initiative, and retains the Nal’ibali logo and web address wherever possible; it is for personal, educational and developmental purposes only; it may not be sold, used or distributed commercially or for a fee.
281
+ We also license the code, actual packaging and the metadata of these data under the cc0-1.0.
282
+
283
  ## Github
284
  We additionally provide a GitHub version that openly shares the source code for processing this dataset:
285
  https://github.com/cisnlp/GlotStoryBook
286
 
287
 
288
+
289
  ## Citation
290
+ If you use any part of this code and data in your research, please cite it (along with https://github.com/global-asp/ and https://nalibali.org) using the following BibTeX entry.
291
+ This work is part of the [GlotLID](https://github.com/cisnlp/GlotLID) project and [paper](https://arxiv.org/abs/2310.16248).
292
 
293
  ```
294
  @inproceedings{