sabilmakbar commited on
Commit
ba2fccd
1 Parent(s): b91d0d1

Update README

Browse files
Files changed (1) hide show
  1. README.md +66 -51
README.md CHANGED
@@ -13,6 +13,36 @@ source_datasets:
13
  task_categories:
14
  - text-generation
15
  - fill-mask
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
  task_ids:
17
  - language-modeling
18
  - masked-language-modeling
@@ -506,7 +536,7 @@ dataset = load_dataset(
506
 
507
  # **FAQS**
508
  ### What are the available languages provided in dataset and from which country?
509
- You may check the following tables to understand the current coverage of this dataset (languages, countries, data size & volume).
510
 
511
  #### 1. Table of Countries and its Country Code
512
  | Country Code | Country Name | Wiki Info |
@@ -524,38 +554,38 @@ You may check the following tables to understand the current coverage of this da
524
  | vnm | Vietnam | [Wiki Link](https://en.wikipedia.org/wiki/Vietnam) |
525
 
526
  #### 2. Table of Languages and Countries of its speakers
527
- | Lang Code | Lang Name | Country Codes Spoken | Wiki Info | Total Data | Total Size (MiB rounded) |
528
- | :---: | :---: | :---: | :--- | ---: | ---: |
529
- | ace | Acehnese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Acehnese_language) | 12904 | 4.64 |
530
- | ban | Balinese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Balinese_language) | 19837 | 16.56 |
531
- | bjn | Banjarese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Banjarese_language) | 10437 | 6.35 |
532
- | bcl | Central Bicolano | phl | [Wiki Link](https://en.wikipedia.org/wiki/Banjarese_language) | 15743 | 19.32 |
533
- | bug | Buginese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Buginese_language) | 9793 | 1.98 |
534
- | ceb | Cebuano | phl | [Wiki Link](https://en.wikipedia.org/wiki/Central_Bicolano_language) | *Not Supported Yet* | *Not Supported Yet* |
535
- | cbk (ISO 639-3) <br> cbk_zam (WikiMedia) | Zamboanga Chavacano/Chavacano | phl | [Wiki Link](https://en.wikipedia.org/wiki/Chavacano) | 3285 | 1.94 |
536
- | gor | Gorontalo | idn | [Wiki Link](https://en.wikipedia.org/wiki/Gorontalo_language) | 14514 | 5.71 |
537
- | ilo | Ilokano | phl | [Wiki Link](https://en.wikipedia.org/wiki/Ilocano_language) | 15371 | 15.94 |
538
- | km | Khmer | khm | [Wiki Link](https://en.wikipedia.org/wiki/Khmer_language) | 11994 | 98.37 |
539
- | id | Indonesian | idn | [Wiki Link](https://en.wikipedia.org/wiki/Indonesian_language) | 654287 | 1049.93 |
540
- | jv | Javanese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Javanese_language) | 72667 | 66.54 |
541
- | lo | Lao | lao | [Wiki Link](https://en.wikipedia.org/wiki/Lao_language) | 5014 | 14.53 |
542
- | mad | Madurese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Madurese_language) | 1192 | 1.54 |
543
- | map_bms | Banyumasan <br>(Dialect of Javanese) | idn | [Wiki Link](https://en.wikipedia.org/wiki/Banyumasan_dialect) | 11832 | 4.83 |
544
- | mnw | Mon | mmr | [Wiki Link](https://en.wikipedia.org/wiki/Mon_language) | 3296 | 45.13 |
545
- | min | Minangkabau | idn | [Wiki Link](https://en.wikipedia.org/wiki/Minangkabau_language) | 225858 | 110.99 |
546
- | ms | Malay | mys, sgp, brn, idn | [Wiki Link](https://en.wikipedia.org/wiki/Malay_language) | 346186 | 391.43 |
547
- | my | Burmese | mmr | [Wiki Link](https://en.wikipedia.org/wiki/Burmese_language) | 109310 | 298.85 |
548
- | nia | Nias | idn | [Wiki Link](https://en.wikipedia.org/wiki/Nias_language) | 1650 | 1.85 |
549
- | pag | Pangasinan | phl | [Wiki Link](https://en.wikipedia.org/wiki/Pangasinan_language) | 2665 | 1.31 |
550
- | pam | Kapampangan | phl | [Wiki Link](https://en.wikipedia.org/wiki/Kapampangan_language) | 9006 | 7.84 |
551
- | shn | Shan | mmr | [Wiki Link](https://en.wikipedia.org/wiki/Shan_language) | 13945 | 32.19 |
552
- | su | Sundanese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Sundanese_language) | 61494 | 45.21 |
553
- | ta | Tamil | mys, sgp | [Wiki Link](https://en.wikipedia.org/wiki/Tamil_language) | 160651 | 0.15 |
554
- | tet | Tetum | tls, idn | [Wiki Link](https://en.wikipedia.org/wiki/Tetum_language) | 1465 | 1.39 |
555
- | th | Thai | tha | [Wiki Link](https://en.wikipedia.org/wiki/Thai_language) | 159719 | 966.00 |
556
- | tl | Tagalog | phl | [Wiki Link](https://en.wikipedia.org/wiki/Tagalog_language) | 45341 | 81.42 |
557
- | vi | Vietnamese | vnm | [Wiki Link](https://en.wikipedia.org/wiki/Vietnamese_language) | 1288680 | 1528.79 |
558
- | war | Waray | phl | [Wiki Link](https://en.wikipedia.org/wiki/Waray_language) | 1266394 | 433.26 |
559
 
560
 
561
  #### 3. Table of Token Statistics for Covered Languages
@@ -569,6 +599,7 @@ The token statistics is generated using ```tiktoken``` using encoder for GPT-4.
569
  | bjn | 1,935,505 | 184.28115776444827 | 2 | 30,170 | [36.0, 38.0, 39.0, 40.0, 42.0, 51.0, 82.0, 151.0, 367.0] |
570
  | bug | 553,693 | 55.54147858360919 | 1 | 13,951 | [31.0, 42.0, 43.0, 46.0, 48.0, 50.0, 52.0, 55.0, 57.0] |
571
  | cbk_zam | 402,703 | 179.6177520071365 | 2 | 6,494 | [35.0, 41.2, 56.0, 69.0, 90.0, 120.0, 138.0, 155.0, 294.9] |
 
572
  | gor | 1,575,766 | 103.05860039241334 | 2 | 5,525 | [55.0, 58.0, 60.0, 62.0, 64.0, 66.0, 69.0, 75.0, 96.0] |
573
  | id | 325,411,713 | 491.22975561670967 | 1 | 198,597 | [54.0, 93.0, 123.0, 145.0, 180.0, 226.0, 332.0, 543.0, 1068.0] |
574
  | ilo | 5,593,491 | 363.94632051532307 | 17 | 18,202 | [59.0, 80.0, 91.0, 111.0, 152.0, 213.0, 303.0, 461.0, 856.0] |
@@ -591,7 +622,7 @@ The token statistics is generated using ```tiktoken``` using encoder for GPT-4.
591
  | th | 330,964,733 | 2,072.8566695476807 | 1 | 289,150 | [231.0, 390.0, 546.0, 727.0, 969.0, 1276.0, 1741.0, 2533.0, 4361.0] |
592
  | tl | 27,789,730 | 615.8934864032269 | 7 | 60,728 | [73.0, 116.0, 161.0, 214.0, 281.0, 360.0, 465.0, 666.0, 1136.0] |
593
  | vi | 546,481,258 | 424.3163404275143 | 3 | 246,463 | [46.0, 64.0, 71.0, 80.0, 86.0, 92.0, 120.0, 240.0, 824.0] |
594
- | war | 117,438,315 | 92.74833676090108 | 1 | 25,689 | [60.0, 77.0, 81.0, 84.0, 87.0, 90.0, 94.0, 99.0, 110.0] |`
595
 
596
  Some other languages in SEA that are already exists its Wiki Index at Wikimedia might be missing from this list. Any lang update PR is greatly appreciated!
597
 
@@ -601,23 +632,7 @@ The data available in here are processed with following flows:
601
  2. Furthermore, the ```title``` and ```text``` data are being checked for string-matching duplication (duplication of text that are being pre-processed, i.e symbols removed, HTML tags striped, or ASCII-chars/UTF-8 chars validated). You may check this [ ```dedup_raw_wiki_data.py```](https://huggingface.co/datasets/sabilmakbar/sea_wiki/blob/main/dedup_raw_wiki_data.py) script to understand its implementation.
602
 
603
  ### How do I extract new Wikipedia Dataset of SEA languages?
604
- You may check to the script [_```extract_raw_wiki_data.py```_](https://huggingface.co/datasets/sabilmakbar/sea_wiki/blob/main/extract_raw_wiki_data.py) to understand its implementations, or you can adjust the bash provided in [_```extract_raw_wiki_data_sea.sh```_](https://huggingface.co/datasets/sabilmakbar/sea_wiki/blob/main/extract_raw_wiki_data_sea.sh) to extract it on your own.
605
-
606
- ### How do I extract new Wikipedia Dataset of SEA languages?
607
- You may visit this [Wikipedia Dump Index](https://dumps.wikimedia.org/backup-index.html) to check any latest available data and this link [Wikipedia Language Coverage](https://meta.wikimedia.org/wiki/List_of_Wikipedias_by_country) to map into any languages that you're wanting to extract. Please note that this dataset is extensible to any languages of your choice.
608
-
609
- ### To replicate the whole dataset generation process ###
610
- 1. Set-up a new Python/Conda Environment (recommended Python version: 3.9.6 to 3.9.18 or 3.10.0 to 3.10.13) and install the requirements on ```requirements.txt``` use this codebase via ```pip install -r requirements.txt```.
611
-
612
- 2. Activate the chosen Python/Conda environment which the requirements are being installed.
613
-
614
- 3. Force install ```multiprocess==0.70.15``` by using ```pip install multiprocess==0.70.15``` to avoid [this issue](https://github.com/huggingface/datasets/issues/5613#issuecomment-1703169594) (there's no other workaround for now)
615
-
616
- 4. Run this ```sh``` script for extractions from Wikiedia HF using ```sh extract_raw_wiki_data_sea.sh```<br>
617
- This script will run [_```extract_raw_wiki_data.py```_](https://huggingface.co/datasets/sabilmakbar/sea_wiki/blob/main/extract_raw_wiki_data.py) to construct the Wiki Dataset.
618
-
619
- 5. Run this ```sh``` script for deduplications from extracted data in Step 4 using ```sh dedup_raw_wiki_data_sea.sh```<br>
620
- This script will run [_```dedup_raw_wiki_data.py```_](https://huggingface.co/datasets/sabilmakbar/sea_wiki/blob/main/dedup_raw_wiki_data.py) to do Wiki Dataset Clenasing. Please note that the cleansing process can be language/dialect specific.
621
 
622
  ## Citation Info:
623
  ```
 
13
  task_categories:
14
  - text-generation
15
  - fill-mask
16
+ language:
17
+ - ace
18
+ - ban
19
+ - bcl
20
+ - bjn
21
+ - bug
22
+ - cbk
23
+ - ceb
24
+ - gor
25
+ - id
26
+ - ilo
27
+ - jv
28
+ - km
29
+ - lo
30
+ - mad
31
+ - min
32
+ - mnw
33
+ - ms
34
+ - my
35
+ - nia
36
+ - pag
37
+ - pam
38
+ - shn
39
+ - su
40
+ - ta
41
+ - th
42
+ - tl
43
+ - tet
44
+ - vi
45
+ - war
46
  task_ids:
47
  - language-modeling
48
  - masked-language-modeling
 
536
 
537
  # **FAQS**
538
  ### What are the available languages provided in dataset and from which country?
539
+ You may check the following tables to understand the current coverage of this dataset (languages, countries, data size & volume). All tables are sorted by the leftmost column.
540
 
541
  #### 1. Table of Countries and its Country Code
542
  | Country Code | Country Name | Wiki Info |
 
554
  | vnm | Vietnam | [Wiki Link](https://en.wikipedia.org/wiki/Vietnam) |
555
 
556
  #### 2. Table of Languages and Countries of its speakers
557
+ | ISO 639-3 Lang Code | Dataset Lang Code | Lang Name | Country Codes Spoken | Wiki Info | Total Data | Total Size (MiB rounded) |
558
+ | :---: | :---: | :---: | :---: | :--- | ---: | ---: |
559
+ | ace | ace | Acehnese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Acehnese_language) | 12979 | 4.72 |
560
+ | ban | ban | Balinese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Balinese_language) | 20611 | 17.19 |
561
+ | bcl | bcl | Central Bicolano | phl | [Wiki Link](https://en.wikipedia.org/wiki/Banjarese_language) | 14079 | 19.05 |
562
+ | bjn | bjn | Banjarese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Banjarese_language) | 10503 | 6.47 |
563
+ | bug | bug | Buginese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Buginese_language) | 9969 | 2.08 |
564
+ | bur | my | Burmese | mmr | [Wiki Link](https://en.wikipedia.org/wiki/Burmese_language) | 108819 | 298.49 |
565
+ | cbk | cbk_zam | Zamboanga Chavacano/Chavacano | phl | [Wiki Link](https://en.wikipedia.org/wiki/Chavacano) | 2242 | 1.51 |
566
+ | ceb | ceb | Cebuano | phl | [Wiki Link](https://en.wikipedia.org/wiki/Central_Bicolano_language) | 5815254 | 4,145.16 |
567
+ | gor | gor | Gorontalo | idn | [Wiki Link](https://en.wikipedia.org/wiki/Gorontalo_language) | 15290 | 5.93 |
568
+ | ilo | ilo | Ilokano | phl | [Wiki Link](https://en.wikipedia.org/wiki/Ilocano_language) | 15369 | 15.94 |
569
+ | ind | id | Indonesian | idn | [Wiki Link](https://en.wikipedia.org/wiki/Indonesian_language) | 662443 | 1,066.10 |
570
+ | jav | jv | Javanese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Javanese_language) | 73080 | 68.66 |
571
+ | khm | km | Khmer | khm | [Wiki Link](https://en.wikipedia.org/wiki/Khmer_language) | 11466 | 97.94 |
572
+ | lao | lo | Lao | lao | [Wiki Link](https://en.wikipedia.org/wiki/Lao_language) | 4897 | 14.22 |
573
+ | mad | mad | Madurese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Madurese_language) | 1192 | 1.54 |
574
+ | may | ms | Malay | mys, sgp, brn, idn | [Wiki Link](https://en.wikipedia.org/wiki/Malay_language) | 348045 | 395.57 |
575
+ | min | min | Minangkabau | idn | [Wiki Link](https://en.wikipedia.org/wiki/Minangkabau_language) | 225972 | 111.31 |
576
+ | mnw | mnw | Mon | mmr | [Wiki Link](https://en.wikipedia.org/wiki/Mon_language) | 3271 | 45.05 |
577
+ | nia | nia | Nias | idn | [Wiki Link](https://en.wikipedia.org/wiki/Nias_language) | 1714 | 2.05 |
578
+ | pag | pag | Pangasinan | phl | [Wiki Link](https://en.wikipedia.org/wiki/Pangasinan_language) | 1108 | 0.73 |
579
+ | pam | pam | Kapampangan | phl | [Wiki Link](https://en.wikipedia.org/wiki/Kapampangan_language) | 8932 | 7.83 |
580
+ | shn | shn | Shan | mmr | [Wiki Link](https://en.wikipedia.org/wiki/Shan_language) | 13662 | 32.06 |
581
+ | sun | su | Sundanese | idn | [Wiki Link](https://en.wikipedia.org/wiki/Sundanese_language) | 61529 | 45.31 |
582
+ | tam | ta | Tamil | mys, sgp | [Wiki Link](https://en.wikipedia.org/wiki/Tamil_language) | 160580 | 771.58 |
583
+ | tgl | tl | Tagalog | phl | [Wiki Link](https://en.wikipedia.org/wiki/Tagalog_language) | 45121 | 81.34 |
584
+ | tha | th | Thai | tha | [Wiki Link](https://en.wikipedia.org/wiki/Thai_language) | 159666 | 965.95 |
585
+ | tet | tet | Tetum | tls, idn | [Wiki Link](https://en.wikipedia.org/wiki/Tetum_language) | 1464 | 1.38 |
586
+ | vie | vi | Vietnamese | vnm | [Wiki Link](https://en.wikipedia.org/wiki/Vietnamese_language) | 1287910 | 1,528.58 |
587
+ | war | war | Waray | phl | [Wiki Link](https://en.wikipedia.org/wiki/Waray_language) | 1266204 | 433.22 |
588
+ | (dialect) | map_bms | Banyumasan <br>(Dialect of Javanese) | idn | [Wiki Link](https://en.wikipedia.org/wiki/Banyumasan_dialect) | 11839 | 4.83 |
589
 
590
 
591
  #### 3. Table of Token Statistics for Covered Languages
 
599
  | bjn | 1,935,505 | 184.28115776444827 | 2 | 30,170 | [36.0, 38.0, 39.0, 40.0, 42.0, 51.0, 82.0, 151.0, 367.0] |
600
  | bug | 553,693 | 55.54147858360919 | 1 | 13,951 | [31.0, 42.0, 43.0, 46.0, 48.0, 50.0, 52.0, 55.0, 57.0] |
601
  | cbk_zam | 402,703 | 179.6177520071365 | 2 | 6,494 | [35.0, 41.2, 56.0, 69.0, 90.0, 120.0, 138.0, 155.0, 294.9] |
602
+ | ceb | 1,319,601,771 | 226.92074516435568 | 4 | 221,802 | [93.0, 108.0, 123.0, 136.0, 163.0, 207.0, 278.0, 377.0, 426.0] |
603
  | gor | 1,575,766 | 103.05860039241334 | 2 | 5,525 | [55.0, 58.0, 60.0, 62.0, 64.0, 66.0, 69.0, 75.0, 96.0] |
604
  | id | 325,411,713 | 491.22975561670967 | 1 | 198,597 | [54.0, 93.0, 123.0, 145.0, 180.0, 226.0, 332.0, 543.0, 1068.0] |
605
  | ilo | 5,593,491 | 363.94632051532307 | 17 | 18,202 | [59.0, 80.0, 91.0, 111.0, 152.0, 213.0, 303.0, 461.0, 856.0] |
 
622
  | th | 330,964,733 | 2,072.8566695476807 | 1 | 289,150 | [231.0, 390.0, 546.0, 727.0, 969.0, 1276.0, 1741.0, 2533.0, 4361.0] |
623
  | tl | 27,789,730 | 615.8934864032269 | 7 | 60,728 | [73.0, 116.0, 161.0, 214.0, 281.0, 360.0, 465.0, 666.0, 1136.0] |
624
  | vi | 546,481,258 | 424.3163404275143 | 3 | 246,463 | [46.0, 64.0, 71.0, 80.0, 86.0, 92.0, 120.0, 240.0, 824.0] |
625
+ | war | 117,438,315 | 92.74833676090108 | 1 | 25,689 | [60.0, 77.0, 81.0, 84.0, 87.0, 90.0, 94.0, 99.0, 110.0] |
626
 
627
  Some other languages in SEA that are already exists its Wiki Index at Wikimedia might be missing from this list. Any lang update PR is greatly appreciated!
628
 
 
632
  2. Furthermore, the ```title``` and ```text``` data are being checked for string-matching duplication (duplication of text that are being pre-processed, i.e symbols removed, HTML tags striped, or ASCII-chars/UTF-8 chars validated). You may check this [ ```dedup_raw_wiki_data.py```](https://huggingface.co/datasets/sabilmakbar/sea_wiki/blob/main/dedup_raw_wiki_data.py) script to understand its implementation.
633
 
634
  ### How do I extract new Wikipedia Dataset of SEA languages?
635
+ Please refer to the corresponding Github Repo for more detailed info [SEA Wiki Github Source Code](https://github.com/sabilmakbar/sea_wiki)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
636
 
637
  ## Citation Info:
638
  ```