oldi_seed / README.md
cointegrated's picture laurievb's picture
Clarify citation information (#8)
37a4145
|
Raw History Blame Contribute Delete
16.6 kB
metadata
annotations_creators:
  - found
language_creators:
  - expert-generated
license: cc-by-sa-4.0
pretty_name: OLDI-Seed
task_categories:
  - text-generation
  - translation
language:
  - ace
  - ary
  - arz
  - bam
  - ban
  - ben
  - bho
  - bjn
  - bug
  - crh
  - dik
  - dzo
  - eng
  - fra
  - fur
  - fuv
  - gug
  - hne
  - ita
  - kas
  - knc
  - lij
  - lim
  - lmo
  - ltg
  - mag
  - mni
  - mri
  - nqo
  - nus
  - pbt
  - prs
  - scn
  - shn
  - spa
  - srd
  - szl
  - taq
  - vec
  - zgh
configs:
  - config_name: default
    data_files:
      - split: train
        path: seed/*.jsonl
  - config_name: ace_Arab
    data_files:
      - split: train
        path: seed/ace_Arab.jsonl
  - config_name: ace_Latn
    data_files:
      - split: train
        path: seed/ace_Latn.jsonl
  - config_name: ary_Arab
    data_files:
      - split: train
        path: seed/ary_Arab.jsonl
  - config_name: arz_Arab
    data_files:
      - split: train
        path: seed/arz_Arab.jsonl
  - config_name: bam_Latn
    data_files:
      - split: train
        path: seed/bam_Latn.jsonl
  - config_name: ban_Latn
    data_files:
      - split: train
        path: seed/ban_Latn.jsonl
  - config_name: ben_Beng
    data_files:
      - split: train
        path: seed/ben_Beng.jsonl
  - config_name: bho_Deva
    data_files:
      - split: train
        path: seed/bho_Deva.jsonl
  - config_name: bjn_Arab
    data_files:
      - split: train
        path: seed/bjn_Arab.jsonl
  - config_name: bjn_Latn
    data_files:
      - split: train
        path: seed/bjn_Latn.jsonl
  - config_name: bug_Latn
    data_files:
      - split: train
        path: seed/bug_Latn.jsonl
  - config_name: crh_Latn
    data_files:
      - split: train
        path: seed/crh_Latn.jsonl
  - config_name: dik_Latn
    data_files:
      - split: train
        path: seed/dik_Latn.jsonl
  - config_name: dzo_Tibt
    data_files:
      - split: train
        path: seed/dzo_Tibt.jsonl
  - config_name: eng_Latn
    data_files:
      - split: train
        path: seed/eng_Latn.jsonl
  - config_name: fra_Latn
    data_files:
      - split: train
        path: seed/fra_Latn.jsonl
  - config_name: fur_Latn
    data_files:
      - split: train
        path: seed/fur_Latn.jsonl
  - config_name: fuv_Latn
    data_files:
      - split: train
        path: seed/fuv_Latn.jsonl
  - config_name: gug_Latn
    data_files:
      - split: train
        path: seed/gug_Latn.jsonl
  - config_name: hne_Deva
    data_files:
      - split: train
        path: seed/hne_Deva.jsonl
  - config_name: ita_Latn
    data_files:
      - split: train
        path: seed/ita_Latn.jsonl
  - config_name: kas_Arab
    data_files:
      - split: train
        path: seed/kas_Arab.jsonl
  - config_name: kas_Deva
    data_files:
      - split: train
        path: seed/kas_Deva.jsonl
  - config_name: knc_Arab
    data_files:
      - split: train
        path: seed/knc_Arab.jsonl
  - config_name: knc_Latn
    data_files:
      - split: train
        path: seed/knc_Latn.jsonl
  - config_name: lij_Latn
    data_files:
      - split: train
        path: seed/lij_Latn.jsonl
  - config_name: lim_Latn
    data_files:
      - split: train
        path: seed/lim_Latn.jsonl
  - config_name: lmo_Latn
    data_files:
      - split: train
        path: seed/lmo_Latn.jsonl
  - config_name: ltg_Latn
    data_files:
      - split: train
        path: seed/ltg_Latn.jsonl
  - config_name: mag_Deva
    data_files:
      - split: train
        path: seed/mag_Deva.jsonl
  - config_name: mni_Beng
    data_files:
      - split: train
        path: seed/mni_Beng.jsonl
  - config_name: mri_Latn
    data_files:
      - split: train
        path: seed/mri_Latn.jsonl
  - config_name: nqo_Nkoo
    data_files:
      - split: train
        path: seed/nqo_Nkoo.jsonl
  - config_name: nus_Latn
    data_files:
      - split: train
        path: seed/nus_Latn.jsonl
  - config_name: pbt_Arab
    data_files:
      - split: train
        path: seed/pbt_Arab.jsonl
  - config_name: prs_Arab
    data_files:
      - split: train
        path: seed/prs_Arab.jsonl
  - config_name: scn_Latn
    data_files:
      - split: train
        path: seed/scn_Latn.jsonl
  - config_name: shn_Mymr
    data_files:
      - split: train
        path: seed/shn_Mymr.jsonl
  - config_name: spa_Latn
    data_files:
      - split: train
        path: seed/spa_Latn.jsonl
  - config_name: srd_Latn
    data_files:
      - split: train
        path: seed/srd_Latn.jsonl
  - config_name: szl_Latn
    data_files:
      - split: train
        path: seed/szl_Latn.jsonl
  - config_name: taq_Latn
    data_files:
      - split: train
        path: seed/taq_Latn.jsonl
  - config_name: taq_Tfng
    data_files:
      - split: train
        path: seed/taq_Tfng.jsonl
  - config_name: vec_Latn
    data_files:
      - split: train
        path: seed/vec_Latn.jsonl
  - config_name: zgh_Tfng
    data_files:
      - split: train
        path: seed/zgh_Tfng.jsonl

OLDI Seed Machine Translation Datacard

OLDI Seed is a machine translation dataset designed to be used to kick-start machine translation models for language directions which currently lack large-scale datasets.

Dataset Details

Dataset Description

OLDI Seed is a parallel corpus which consists of 6,193 sentences sampled from English Wikipedia and translated into 44 languages. It can be used to kick-start machine translation models for language directions which currently lack large-scale datasets.

The data, which is licensed under CC BY-SA 4.0, is currently being managed by OLDI, the Open Language Data Initiative.

Citation

OLDI Seed is an updated version of the open source seed dataset described in the paper Small Data, Big Impact: Leveraging Minimal Data for Effective Machine Translation.

Other authors have since contributed to the dataset. If you use OLDI Seed in your work, please cite the relevant papers listed in bibliography.bib.

Uses

OLDI Seed is intended to be used to kick-start machine translation models for language directions which currently lack large-scale datasets.

Dataset Structure

Each instance in the dataset is structured as in the following example:

{
  "id": 17,
  "iso_639_3": "gug",
  "iso_15924": "Latn",
  "glottocode": "para1311",
  "text": "Osẽ emperatriz viuda Maria Feodorovna-ramo peteĩ musical de Broadway mbykymi héravaa Anya 1965 arýpe.",
  "url": "https://en.wikipedia.org/wiki/Lillian_Gish",
  "last_updated": "1.0"
}

Data Fields

  • id: ID number for each line of data. Lines with the same ID in the same split are translations of each other.
  • iso_639_3: The ISO 639-3 code indicating the language variety.
  • iso_15924: The ISO 15924 code indicating the script.
  • glottocode: The Glottocode corresponding to the language variety.
  • text: A line of text in the indicated language.
  • url: The URL for the English article from which the sentence was extracted.
  • last_updated: The version number of the dataset in which the entry was last updated.

Dataset Creation

See the paper Small Data, Big Impact: Leveraging Minimal Data for Effective Machine Translation and the NLLB paper for more details.

Additional Datacards

The datasets for some language varieties have individual datacards describing their creation. These can be found in the dataset_cards directory.

Dataset Card Contact

For more information about the OLDI Seed dataset, please see oldi.org

Contributing

Fixes and new language contributions are most welcome.

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.

In order to show your agreement with the DCO you should include at the end of commit message, the following line: Signed-off-by: John Doe <john.doe@example.com>, using your real name.

This can be done easily using the -s flag on the git commit.

Please see the Contribution guidelines for further information.

How to add a pull request

  1. Go to https://huggingface.co/datasets/openlanguagedata/oldi_seed/discussions, press "New pull request".
  2. In the popup window, enter a branch name and press "Create branch".
  3. On your computer, do git clone https://huggingface.co/datasets/openlanguagedata/oldi_seed.
  4. Checkout to your newly created branch (e.g. cd oldi_seed && git fetch origin refs/pr/4:pr/4 && git checkout pr/4).
  5. Check that you are logged in to the HF CLI tool (hf auth whoami). If not, please log into it (hf auth login and enter your token).
  6. Modify a file (for adding new languages, see the instructions below) and add the changes to git (e.g. git add seed/rus_Cyrl.jsonl).
  7. Commit with an -s flag (e.g. git commit -s -m "fix a few typos in the Russian dev set").
  8. Push (e.g. git push origin pr/4:refs/pr/4) — important to make sure to push to the same "refs" branch!
  9. Go to the pull request page and see if it reflects your changes.
  10. When your pull request is ready, press the "Publish" button in its web interface.

If you find this difficult, please contact us by email info@oldi.org or in our Discord group!

Testing your changes

After contributing new translations or modifying existing ones, you can check that the data format is OK. Assuming that you have the Python packages pytest and dataset installed, you can type

pytest

in your console (in the oldi_seed directory), and the tests will run. If any of them fails, please inspect the translations, following the hints in the test output.

Changelog

See CHANGELOG.md for information about the latest changes.

Language coverage

Code Script Glottocode Name Notes
ace Arab achi1257 Acehnese (Jawi script)
ace Latn achi1257 Acehnese (Latin script)
ary Arab moro1292 Moroccan Arabic
arz Arab egyp1253 Egyptian Arabic
bam Latn bamb1269 Bambara
ban Latn bali1278 Balinese
ben Beng beng1280 Bengali
bho Deva bhoj1244 Bhojpuri
bjn Arab banj1239 Banjar (Jawi script)
bjn Latn banj1239 Banjar (Latin script)
bug Latn bugi1244 Buginese
crh Latn crim1257 Crimean Tatar
dik Latn sout2832 Southwestern Dinka
dzo Tibt dzon1239 Dzongkha
eng Latn stan1293 English
fra Latn stan1290 French
fur Latn east2271 Friulian
fuv Latn nige1253 Nigerian Fulfulde
gug Latn para1311 Paraguayan Guaraní
hne Deva chha1249 Chhattisgarhi
ita Latn ital1282 Italian
kas Arab kash1277 Kashmiri (Arabic script)
kas Deva kash1277 Kashmiri (Devanagari script)
kir Cyrl kirg1245 Kyrgyz
knc Arab cent2050 Central Kanuri (Arabic script)
knc Latn cent2050 Central Kanuri (Latin script)
lij Latn geno1240 Ligurian (Genoese)
lim Latn limb1263 Limburgish
lmo Latn lomb1257 Lombard [1]
ltg Latn east2282 Latgalian
mag Deva maga1260 Magahi
mni Beng mani1292 Meitei (Manipuri, Bengali script)
mri Latn maor1246 Maori
nqo Nkoo nkoa1234 Nko
nus Latn nuer1246 Nuer
pbt Arab sout2649 Southern Pashto
prs Arab dari1249 Dari
scn Latn sici1248 Sicilian
shn Mymr shan1277 Shan
spa Latn amer1254 Spanish (Latin American)
srd Latn sard1257 Sardinian [1]
szl Latn sile1253 Silesian
taq Latn tama1365 Tamasheq (Latin script)
taq Tfng tama1365 Tamasheq (Tifinagh script)
vec Latn vene1259 Venetian
zgh Tfng stan1324 Standard Moroccan Tamazight