Update README.md

README.md

@@ -24,7 +24,230 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+license: odc-by
+task_categories:
+- translation
+pretty_name: nllb-200-10M-sample
+size_categories:
+- 1M<n<10M
+language:
+  - ak   # aka_Latn Akan
+  - am   # amh_Ethi Amharic
+  - ar   # arb_Arab Modern Standard Arabic
+  - awa  # awa_Deva Awadhi
+  - azj  # azj_Latn North Azerbaijani
+  - bm   # bam_Latn Bambara
+  - ban  # ban_Latn Balinese
+  - be   # bel_Cyrl Belarusian
+  - bem  # bem_Latn Bemba
+  - bn   # ben_Beng Bengali
+  - bho  # bho_Deva Bhojpuri
+  - bjn  # bjn_Latn Banjar (Latin script)
+  - bug  # bug_Latn Buginese
+  - bg   # bul_Cyrl Bulgarian
+  - ca   # cat_Latn Catalan
+  - ceb  # ceb_Latn Cebuano
+  - cs   # ces_Latn Czech
+  - cjk  # cjk_Latn Chokwe
+  - ckb  # ckb_Arab Central Kurdish
+  - crh  # crh_Latn Crimean Tatar
+  - da   # dan_Latn Danish
+  - de   # deu_Latn German
+  - dik  # dik_Latn Southwestern Dinka
+  - dyu  # dyu_Latn Dyula
+  - el   # ell_Grek Greek
+  - en   # eng_Latn English
+  - eo   # epo_Latn Esperanto
+  - et   # est_Latn Estonian
+  - ee   # ewe_Latn Ewe
+  - fo   # fao_Latn Faroese
+  - fj   # fij_Latn Fijian
+  - fi   # fin_Latn Finnish
+  - fon  # fon_Latn Fon
+  - fr   # fra_Latn French
+  - fur  # fur_Latn Friulian
+  - ff   # fuv_Latn Nigerian Fulfulde
+  - gaz  # gaz_Latn West Central Oromo
+  - gd   # gla_Latn Scottish Gaelic
+  - ga   # gle_Latn Irish
+  - gl   # glg_Latn Galician
+  - gn   # grn_Latn Guarani
+  - gu   # guj_Gujr Gujarati
+  - ht   # hat_Latn Haitian Creole
+  - ha   # hau_Latn Hausa
+  - he   # heb_Hebr Hebrew
+  - hi   # hin_Deva Hindi
+  - hne  # hne_Deva Chhattisgarhi
+  - hr   # hrv_Latn Croatian
+  - hu   # hun_Latn Hungarian
+  - hy   # hye_Armn Armenian
+  - ig   # ibo_Latn Igbo
+  - ilo  # ilo_Latn Ilocano
+  - id   # ind_Latn Indonesian
+  - is   # isl_Latn Icelandic
+  - it   # ita_Latn Italian
+  - jv   # jav_Latn Javanese
+  - ja   # jpn_Jpan Japanese
+  - kab  # kab_Latn Kabyle
+  - kac  # kac_Latn Jingpho
+  - kam  # kam_Latn Kamba
+  - kn   # kan_Knda Kannada
+  - ks   # kas_Arab Kashmiri (Arabic script)
+  - ks   # kas_Deva Kashmiri (Devanagari script)
+  - ka   # kat_Geor Georgian
+  - kk   # kaz_Cyrl Kazakh
+  - kbp  # kbp_Latn Kabiyè
+  - kea  # kea_Latn Kabuverdianu
+  - mn   # khk_Cyrl Halh Mongolian
+  - km   # khm_Khmr Khmer
+  - ki   # kik_Latn Kikuyu
+  - rw   # kin_Latn Kinyarwanda
+  - ky   # kir_Cyrl Kyrgyz
+  - kmb  # kmb_Latn Kimbundu
+  - kmr  # kmr_Latn Northern Kurdish
+  - kr   # knc_Arab Central Kanuri (Arabic script)
+  - kr   # knc_Latn Central Kanuri (Latin script)
+  - kg   # kon_Latn Kikongo
+  - ko   # kor_Hang Korean
+  - lo   # lao_Laoo Lao
+  - lij  # lij_Latn Ligurian
+  - li   # lim_Latn Limburgish
+  - ln   # lin_Latn Lingala
+  - lt   # lit_Latn Lithuanian
+  - lmo  # lmo_Latn Lombard
+  - ltg  # ltg_Latn Latgalian
+  - lb   # ltz_Latn Luxembourgish
+  - lua  # lua_Latn Luba-Kasai
+  - lg   # lug_Latn Ganda
+  - luo  # luo_Latn Luo
+  - lus  # lus_Latn Mizo
+  - lv   # lvs_Latn Standard Latvian
+  - mag  # mag_Deva Magahi
+  - mai  # mai_Deva Maithili
+  - ml   # mal_Mlym Malayalam
+  - mr   # mar_Deva Marathi
+  - min  # min_Latn Minangkabau (Latin script)
+  - mk   # mkd_Cyrl Macedonian
+  - mt   # mlt_Latn Maltese
+  - mni  # mni_Beng Meitei (Bengali script)
+  - mos  # mos_Latn Mossi
+  - mi   # mri_Latn Maori
+  - my   # mya_Mymr Burmese
+  - nl   # nld_Latn Dutch
+  - nb   # nob_Latn Norwegian Bokmål
+  - ne   # npi_Deva Nepali
+  - nso  # nso_Latn Northern Sotho
+  - nus  # nus_Latn Nuer
+  - ny   # nya_Latn Nyanja
+  - oc   # oci_Latn Occitan
+  - ory  # ory_Orya Odia
+  - pag  # pag_Latn Pangasinan
+  - pa   # pan_Guru Eastern Panjabi
+  - pap  # pap_Latn Papiamento
+  - pbt  # pbt_Arab Southern Pashto
+  - fa   # pes_Arab Western Persian
+  - plt  # plt_Latn Plateau Malagasy
+  - pl   # pol_Latn Polish
+  - pt   # por_Latn Portuguese
+  - prs  # prs_Arab Dari
+  - qu   # quy_Latn Ayacucho Quechua
+  - ro   # ron_Latn Romanian
+  - rn   # run_Latn Rundi
+  - ru   # rus_Cyrl Russian
+  - sg   # sag_Latn Sango
+  - sa   # san_Deva Sanskrit
+  - sat  # sat_Beng ?
+  - scn  # scn_Latn Sicilian
+  - shn  # shn_Mymr Shan
+  - si   # sin_Sinh Sinhala
+  - sk   # slk_Latn Slovak
+  - sl   # slv_Latn Slovenian
+  - sm   # smo_Latn Samoan
+  - sn   # sna_Latn Shona
+  - sd   # snd_Arab Sindhi
+  - so   # som_Latn Somali
+  - st   # sot_Latn Southern Sotho
+  - es   # spa_Latn Spanish
+  - sc   # srd_Latn Sardinian
+  - sr   # srp_Cyrl Serbian
+  - ss   # ssw_Latn Swati
+  - su   # sun_Latn Sundanese
+  - sv   # swe_Latn Swedish
+  - sw   # swh_Latn Swahili
+  - szl  # szl_Latn Silesian
+  - ta   # tam_Taml Tamil
+  - taq  # taq_Latn Tamasheq (Latin script)
+  - tt   # tat_Cyrl Tatar
+  - te   # tel_Telu Telugu
+  - tg   # tgk_Cyrl Tajik
+  - tl   # tgl_Latn Tagalog
+  - ti   # tir_Ethi Tigrinya
+  - tpi  # tpi_Latn Tok Pisin
+  - tn   # tsn_Latn Tswana
+  - ts   # tso_Latn Tsonga
+  - tk   # tuk_Latn Turkmen
+  - tum  # tum_Latn Tumbuka
+  - tr   # tur_Latn Turkish
+  - tw   # twi_Latn Twi
+  - tzm  # tzm_Tfng Central Atlas Tamazight
+  - ug   # uig_Arab Uyghur
+  - uk   # ukr_Cyrl Ukrainian
+  - umb  # umb_Latn Umbundu
+  - ur   # urd_Arab Urdu
+  - uz   # uzn_Latn Northern Uzbek
+  - vec  # vec_Latn Venetian
+  - vi   # vie_Latn Vietnamese
+  - war  # war_Latn Waray
+  - wo   # wol_Latn Wolof
+  - xh   # xho_Latn Xhosa
+  - yi   # ydd_Hebr Eastern Yiddish
+  - yo   # yor_Latn Yoruba
+  - zh   # zho_Hans Chinese (Simplified)
+  - zh   # zho_Hant Chinese (Traditional)
+  - ms   # zsm_Latn Standard Malay
+  - zu   # zul_Latn Zulu
 ---
 # Dataset Card for "nllb-200-10M-sample"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+This is a sample of nearly 10M sentence pairs from the [NLLB-200](https://arxiv.org/abs/2207.04672) 
+mined dataset [allenai/nllb](https://huggingface.co/datasets/allenai/nllb), 
+scored with the model [facebook/blaser-2.0-qe](https://huggingface.co/facebook/blaser-2.0-qe) 
+described in the [SeamlessM4T](https://arxiv.org/abs/2308.11596) paper.
+
+The sample is not random; instead, we just took the top `n` language pairs from each translation direction.
+The number `n` was computed with the goal of upsamping the directions that contain underrepresented languages.
+Nevertheless, the 187 languoids (language and script combinations) are not represented equally,
+with most languoids totaling 36K to 200K sentences.
+Over 60% of the sentence pairs have BLASER-QE score above 3.5.
+
+This dataset can be used for fine-tuning massively multilingual translation models. 
+We suggest the following scenario:
+- Filter the dataset by the value of `blaser_sim` (the recommended threshold is 3.0 or 3.5);
+- Randomly swapping the source/target roles in the sentence pairs during data loading;
+- Use that data to augment the dataset while fine-tuning an NLLB-like model for a new translation direction,
+in order to mitigate forgetting of all the other translation directions.
+
+The dataset is released under the terms of [ODC-BY](https://opendatacommons.org/licenses/by/1-0/). 
+By using this, you are also bound to the respective Terms of Use and License of the original source.
+
+Citation:
+- NLLB Team et al, No Language Left Behind: Scaling Human-Centered Machine Translation, Arxiv https://arxiv.org/abs/2207.04672, 2022.
+- Seamless Communication et al, SeamlessM4T — Massively Multilingual & Multimodal Machine Translation, Arxiv https://arxiv.org/abs/2308.11596, 2023.
+
+The following language codes are supported. The mapping between languages and codes can be found in the [NLLB-200 paper](https://arxiv.org/abs/2207.04672)
+or in the [FLORES-200 repository](https://github.com/facebookresearch/flores/blob/main/flores200/README.md#languages-in-flores-200).
+```
+aka_Latn amh_Ethi arb_Arab awa_Deva azj_Latn bam_Latn ban_Latn bel_Cyrl bem_Latn ben_Beng bho_Deva bjn_Latn bug_Latn bul_Cyrl
+cat_Latn ceb_Latn ces_Latn cjk_Latn ckb_Arab crh_Latn dan_Latn deu_Latn dik_Latn dyu_Latn ell_Grek eng_Latn epo_Latn est_Latn
+ewe_Latn fao_Latn fij_Latn fin_Latn fon_Latn fra_Latn fur_Latn fuv_Latn gaz_Latn gla_Latn gle_Latn glg_Latn grn_Latn guj_Gujr
+hat_Latn hau_Latn heb_Hebr hin_Deva hne_Deva hrv_Latn hun_Latn hye_Armn ibo_Latn ilo_Latn ind_Latn isl_Latn ita_Latn jav_Latn
+jpn_Jpan kab_Latn kac_Latn kam_Latn kan_Knda kas_Arab kas_Deva kat_Geor kaz_Cyrl kbp_Latn kea_Latn khk_Cyrl khm_Khmr kik_Latn
+kin_Latn kir_Cyrl kmb_Latn kmr_Latn knc_Arab knc_Latn kon_Latn kor_Hang lao_Laoo lij_Latn lim_Latn lin_Latn lit_Latn lmo_Latn
+ltg_Latn ltz_Latn lua_Latn lug_Latn luo_Latn lus_Latn lvs_Latn mag_Deva mai_Deva mal_Mlym mar_Deva min_Latn mkd_Cyrl mlt_Latn
+mni_Beng mos_Latn mri_Latn mya_Mymr nld_Latn nob_Latn npi_Deva nso_Latn nus_Latn nya_Latn oci_Latn ory_Orya pag_Latn pan_Guru
+pap_Latn pbt_Arab pes_Arab plt_Latn pol_Latn por_Latn prs_Arab quy_Latn ron_Latn run_Latn rus_Cyrl sag_Latn san_Deva sat_Beng
+scn_Latn shn_Mymr sin_Sinh slk_Latn slv_Latn smo_Latn sna_Latn snd_Arab som_Latn sot_Latn spa_Latn srd_Latn srp_Cyrl ssw_Latn
+sun_Latn swe_Latn swh_Latn szl_Latn tam_Taml taq_Latn tat_Cyrl tel_Telu tgk_Cyrl tgl_Latn tir_Ethi tpi_Latn tsn_Latn tso_Latn
+tuk_Latn tum_Latn tur_Latn twi_Latn tzm_Tfng uig_Arab ukr_Cyrl umb_Latn urd_Arab uzn_Latn vec_Latn vie_Latn war_Latn wol_Latn
+xho_Latn ydd_Hebr yor_Latn zho_Hans zho_Hant zsm_Latn zul_Latn
+```