Add dataset card

README.md

@@ -1,341 +1,251 @@
 ---
 annotations_creators:
-- expert-generated
+- expert-annotated
 language_creators:
 - expert-generated
 language:
-- af
-- am
-- ar
-- az
-- ba
-- be
-- bg
-- bn
-- bo
-- bs
-- ca
-- cs
-- cy
-- da
-- de
-- dv
-- dz
-- ee
-- el
-- et
-- eu
-- fa
-- fa
-- fi
+- afr
+- amh
+- arb
+- aze
+- bak
+- bel
+- bem
+- ben
+- bod
+- bos
+- bul
+- cat
+- ces
+- ckb
+- cym
+- dan
+- deu
+- div
+- dzo
+- ell
+- eng
+- eus
+- ewe
+- fao
+- fas
+- fij
 - fil
-- fj
-- fj
-- fo
-- fr
-- gd
-- gu
-- ha
-- he
-- hi
+- fin
+- fra
+- fuc
+- gle
+- glg
+- guj
+- hau
+- heb
+- hin
 - hmn
-- hr
-- hu
-- hy
-- id
-- ig
-- is
-- it
-- ja
-- kk
-- km
-- kn
-- ko
-- ku
-- ku
-- ky
-- lb
-- lo
-- lt
-- lv
-- mi
-- mk
-- mn
-- mr
-- ms
-- ms
-- mt
-- my
-- nb
-- nd
-- ne
-- nl
-- nn
-- ny
-- om
-- oy
-- pa
-- ps
-- pt
-- ro
-- ru
-- rw
-- sd
-- sh
+- hrv
+- hun
+- hye
+- ibo
+- ind
+- isl
+- ita
+- jpn
+- kan
+- kat
+- kaz
+- khm
+- kin
+- kir
+- kmr
+- kor
+- lao
+- lav
+- lit
+- ltz
+- mal
+- mar
+- mey
+- mkd
+- mlg
+- mlt
+- mon
+- mri
+- msa
+- mya
+- nde
+- nep
+- nld
+- nno
+- nob
+- nso
+- nya
+- orm
+- pan
+- pol
+- por
+- prs
+- pus
+- ron
+- rus
 - shi
-- si
-- sk
-- sl
-- sm
-- sn
-- so
-- sq
-- sr
-- ss
-- st
-- sv
-- sw
-- ta
-- te
-- tg
-- th
-- tk
-- tn
-- to
-- tr
-- tt
-- ty
-- uk
-- ur
-- uz
-- ve
-- vi
-- wo
-- xh
-- yo
-- zh
-- zh
-- zu
-license:
-- cc-by-sa-4.0
-multilinguality:
-- translation
+- sin
+- slk
+- slv
+- smo
+- sna
+- snd
+- som
+- spa
+- sqi
+- srp
+- ssw
+- swa
+- swe
+- tah
+- tam
+- tat
+- tel
+- tgk
+- tha
+- tir
+- ton
+- tsn
+- tuk
+- tur
+- uig
+- ukr
+- urd
+- uzb
+- ven
+- vie
+- wol
+- xho
+- yor
+- yue
+- zho
+- zul
+license: cc-by-sa-4.0
+multilinguality: translated
+size_categories:
+- '1997'
 task_categories:
 - translation
-size_categories:
-- "1997"
+task_ids: []
 configs:
-  - config_name: default
-    data_files:
-      - split: test
-        path: test.parquet
+- config_name: default
+  data_files:
+  - split: test
+    path: test.parquet
+tags:
+- mteb
+- text
 ---
-## Dataset Description
+<!-- adapted from https://github.com/huggingface/huggingface_hub/blob/v0.30.2/src/huggingface_hub/templates/datasetcard_template.md -->
 
-NTREX -- News Test References for MT Evaluation from English into a total of 128 target languages. See [original GitHub repo](https://github.com/MicrosoftTranslator/NTREX/tree/main) for full details.
+<div align="center" style="padding: 40px 20px; background-color: white; border-radius: 12px; box-shadow: 0 2px 10px rgba(0, 0, 0, 0.05); max-width: 600px; margin: 0 auto;">
+  <h1 style="font-size: 3.5rem; color: #1a1a1a; margin: 0 0 20px 0; letter-spacing: 2px; font-weight: 700;">NTREXBitextMining</h1>
+  <div style="font-size: 1.5rem; color: #4a4a4a; margin-bottom: 5px; font-weight: 300;">An <a href="https://github.com/embeddings-benchmark/mteb" style="color: #2c5282; font-weight: 600; text-decoration: none;" onmouseover="this.style.textDecoration='underline'" onmouseout="this.style.textDecoration='none'">MTEB</a> dataset</div>
+  <div style="font-size: 0.9rem; color: #2c5282; margin-top: 10px;">Massive Text Embedding Benchmark</div>
+</div>
 
-Example of loading:
-```python
-dataset = load_dataset("davidstap/NTREX", "rus_Cyrl", trust_remote_code=True)
-```
+NTREX is a News Test References dataset for Machine Translation Evaluation, covering translation from English into 128 languages. We select language pairs according to the M2M-100 language grouping strategy, resulting in 1916 directions.
+
+|               |                                             |
+|---------------|---------------------------------------------|
+| Task category | t2t                              |
+| Domains       | News, Written                               |
+| Reference     | https://huggingface.co/datasets/davidstap/NTREX |
 
-## Languages
 
-The following languages are available:
+## How to evaluate on this task
 
-| Language Code   | Language Name               |
-|-----------------|-----------------------------|
-| `afr_Latn`      | Afrikaans                   |
-| `amh_Ethi`      | Amharic                     |
-| `arb_Arab`      | Arabic                      |
-| `aze_Latn`      | Azerbaijani                 |
-| `bak_Cyrl`      | Bashkir                     |
-| `bel_Cyrl`      | Belarusian                  |
-| `bem_Latn`      | Bemba                       |
-| `ben_Beng`      | Bengali                     |
-| `bod_Tibt`      | Tibetan                     |
-| `bos_Latn`      | Bosnian                     |
-| `bul_Cyrl`      | Bulgarian                   |
-| `cat_Latn`      | Catalan                     |
-| `ces_Latn`      | Czech                       |
-| `ckb_Arab`      | Sorani Kurdish              |
-| `cym_Latn`      | Welsh                       |
-| `dan_Latn`      | Danish                      |
-| `deu_Latn`      | German                      |
-| `div_Thaa`      | Dhivehi                     |
-| `dzo_Tibt`      | Dzongkha                    |
-| `ell_Grek`      | Greek                       |
-| `eng-GB_Latn`   | English (Great Britain)     |
-| `eng-IN_Latn`   | English (India)             |
-| `eng-US_Latn`   | English (United States)     |
-| `eng_Latn`      | English                     |
-| `est_Latn`      | Estonian                    |
-| `eus_Latn`      | Basque                      |
-| `ewe_Latn`      | Ewe                         |
-| `fao_Latn`      | Faroese                     |
-| `fas_Arab`      | Persian                     |
-| `fij_Latn`      | Fijian                      |
-| `fil_Latn`      | Filipino                    |
-| `fin_Latn`      | Finnish                     |
-| `fra-CA_Latn`   | French (Canada)             |
-| `fra_Latn`      | French                      |
-| `fuc_Latn`      | Pulaar                      |
-| `gle_Latn`      | Irish                       |
-| `glg_Latn`      | Galician                    |
-| `guj_Gujr`      | Gujarati                    |
-| `hau_Latn`      | Hausa                       |
-| `heb_Hebr`      | Hebrew                      |
-| `hin_Deva`      | Hindi                       |
-| `hmn_Latn`      | Hmong                       |
-| `hrv_Latn`      | Croatian                    |
-| `hun_Latn`      | Hungarian                   |
-| `hye_Armn`      | Armenian                    |
-| `ibo_Latn`      | Igbo                        |
-| `ind_Latn`      | Indonesian                  |
-| `isl_Latn`      | Icelandic                   |
-| `ita_Latn`      | Italian                     |
-| `jpn_Jpan`      | Japanese                    |
-| `kan_Knda`      | Kannada                     |
-| `kat_Geor`      | Georgian                    |
-| `kaz_Cyrl`      | Kazakh                      |
-| `khm_Khmr`      | Khmer                       |
-| `kin_Latn`      | Kinyarwanda                 |
-| `kir_Cyrl`      | Kyrgyz                      |
-| `kmr_Latn`      | Northern Kurdish            |
-| `kor_Hang`      | Korean                      |
-| `lao_Laoo`      | Lao                         |
-| `lav_Latn`      | Latvian                     |
-| `lit_Latn`      | Lithuanian                  |
-| `ltz_Latn`      | Luxembourgish               |
-| `mal_Mlym`      | Malayalam                   |
-| `mar_Deva`      | Marathi                     |
-| `mey_Arab`      | Hassaniya Arabic            |
-| `mkd_Cyrl`      | Macedonian                  |
-| `mlg_Latn`      | Malagasy                    |
-| `mlt_Latn`      | Maltese                     |
-| `mon_Mong`      | Mongolian                   |
-| `mri_Latn`      | Maori                       |
-| `msa_Latn`      | Malay                       |
-| `mya_Mymr`      | Burmese                     |
-| `nde_Latn`      | Ndebele                     |
-| `nep_Deva`      | Nepali                      |
-| `nld_Latn`      | Dutch                       |
-| `nno_Latn`      | Norwegian Nynorsk           |
-| `nob_Latn`      | Norwegian Bokmål            |
-| `nso_Latn`      | Northern Sotho              |
-| `nya_Latn`      | Chichewa                    |
-| `orm_Ethi`      | Oromo                       |
-| `pan_Guru`      | Punjabi (Gurmukhi)          |
-| `pol_Latn`      | Polish                      |
-| `por-BR_Latn`   | Portuguese (Brazil)         |
-| `por_Latn`      | Portuguese                  |
-| `prs_Arab`      | Dari                        |
-| `pus_Arab`      | Pashto                      |
-| `ron_Latn`      | Romanian                    |
-| `rus_Cyrl`      | Russian                     |
-| `shi_Arab`      | Tachelhit                   |
-| `sin_Sinh`      | Sinhala                     |
-| `slk_Latn`      | Slovak                      |
-| `slv_Latn`      | Slovenian                   |
-| `smo_Latn`      | Samoan                      |
-| `sna_Latn`      | Shona                       |
-| `snd_Arab`      | Sindhi                      |
-| `som_Latn`      | Somali                      |
-| `spa-MX_Latn`   | Spanish (Mexico)            |
-| `spa_Latn`      | Spanish                     |
-| `sqi_Latn`      | Albanian                    |
-| `srp_Cyrl`      | Serbian (Cyrillic)          |
-| `srp_Latn`      | Serbian (Latin)             |
-| `ssw_Latn`      | Swati                       |
-| `swa_Latn`      | Swahili                     |
-| `swe_Latn`      | Swedish                     |
-| `tah_Latn`      | Tahitian                    |
-| `tam_Taml`      | Tamil                       |
-| `tat_Cyrl`      | Tatar                       |
-| `tel_Telu`      | Telugu                      |
-| `tgk_Cyrl`      | Tajik                       |
-| `tha_Thai`      | Thai                        |
-| `tir_Ethi`      | Tigrinya                    |
-| `ton_Latn`      | Tongan                      |
-| `tsn_Latn`      | Tswana                      |
-| `tuk_Latn`      | Turkmen                     |
-| `tur_Latn`      | Turkish                     |
-| `uig_Arab`      | Uighur                      |
-| `ukr_Cyrl`      | Ukrainian                   |
-| `urd_Arab`      | Urdu                        |
-| `uzb_Latn`      | Uzbek                       |
-| `ven_Latn`      | Venda                       |
-| `vie_Latn`      | Vietnamese                  |
-| `wol_Latn`      | Wolof                       |
-| `xho_Latn`      | Xhosa                       |
-| `yor_Latn`      | Yoruba                      |
-| `yue_Hant`      | Cantonese                   |
-| `zho_Hans`      | Chinese (Simplified)        |
-| `zho_Hant`      | Chinese (Traditional)       |
-| `zul_Latn`      | Zulu                        |
+You can evaluate an embedding model on this dataset using the following code:
 
+```python
+import mteb
 
-### Citation Information
-For the original NTREX-128 dataset, please cite:
+task = mteb.get_tasks(["NTREXBitextMining"])
+evaluator = mteb.MTEB(task)
 
+model = mteb.get_model(YOUR_MODEL)
+evaluator.run(model)
 ```
+
+<!-- Datasets want link to arxiv in readme to autolink dataset with paper -->
+To learn more about how to run models on `mteb` task check out the [GitHub repitory](https://github.com/embeddings-benchmark/mteb). 
+
+## Citation
+
+If you use this dataset, please cite the dataset as well as [mteb](https://github.com/embeddings-benchmark/mteb), as this dataset likely includes additional processing as a part of the [MMTEB Contribution](https://github.com/embeddings-benchmark/mteb/tree/main/docs/mmteb).
+
+```bibtex
+
 @inproceedings{federmann-etal-2022-ntrex,
-    title = "{NTREX}-128 {--} News Test References for {MT} Evaluation of 128 Languages",
-    author = "Federmann, Christian and Kocmi, Tom and Xin, Ying",
-    booktitle = "Proceedings of the First Workshop on Scaling Up Multilingual Evaluation",
-    month = "nov",
-    year = "2022",
-    address = "Online",
-    publisher = "Association for Computational Linguistics",
-    url = "https://aclanthology.org/2022.sumeval-1.4",
-    pages = "21--24",
+  address = {Online},
+  author = {Federmann, Christian and Kocmi, Tom and Xin, Ying},
+  booktitle = {Proceedings of the First Workshop on Scaling Up Multilingual Evaluation},
+  month = {nov},
+  pages = {21--24},
+  publisher = {Association for Computational Linguistics},
+  title = {{NTREX}-128 {--} News Test References for {MT} Evaluation of 128 Languages},
+  url = {https://aclanthology.org/2022.sumeval-1.4},
+  year = {2022},
+}
+
+
+@article{enevoldsen2025mmtebmassivemultilingualtext,
+  title={MMTEB: Massive Multilingual Text Embedding Benchmark},
+  author={Kenneth Enevoldsen and Isaac Chung and Imene Kerboua and Márton Kardos and Ashwin Mathur and David Stap and Jay Gala and Wissam Siblini and Dominik Krzemiński and Genta Indra Winata and Saba Sturua and Saiteja Utpala and Mathieu Ciancone and Marion Schaeffer and Gabriel Sequeira and Diganta Misra and Shreeya Dhakal and Jonathan Rystrøm and Roman Solomatin and Ömer Çağatan and Akash Kundu and Martin Bernstorff and Shitao Xiao and Akshita Sukhlecha and Bhavish Pahwa and Rafał Poświata and Kranthi Kiran GV and Shawon Ashraf and Daniel Auras and Björn Plüster and Jan Philipp Harries and Loïc Magne and Isabelle Mohr and Mariya Hendriksen and Dawei Zhu and Hippolyte Gisserot-Boukhlef and Tom Aarsen and Jan Kostkan and Konrad Wojtasik and Taemin Lee and Marek Šuppa and Crystina Zhang and Roberta Rocca and Mohammed Hamdy and Andrianos Michail and John Yang and Manuel Faysse and Aleksei Vatolin and Nandan Thakur and Manan Dey and Dipam Vasani and Pranjal Chitale and Simone Tedeschi and Nguyen Tai and Artem Snegirev and Michael Günther and Mengzhou Xia and Weijia Shi and Xing Han Lù and Jordan Clive and Gayatri Krishnakumar and Anna Maksimova and Silvan Wehrli and Maria Tikhonova and Henil Panchal and Aleksandr Abramov and Malte Ostendorff and Zheng Liu and Simon Clematide and Lester James Miranda and Alena Fenogenova and Guangyu Song and Ruqiya Bin Safi and Wen-Ding Li and Alessia Borghini and Federico Cassano and Hongjin Su and Jimmy Lin and Howard Yen and Lasse Hansen and Sara Hooker and Chenghao Xiao and Vaibhav Adlakha and Orion Weller and Siva Reddy and Niklas Muennighoff},
+  publisher = {arXiv},
+  journal={arXiv preprint arXiv:2502.13595},
+  year={2025},
+  url={https://arxiv.org/abs/2502.13595},
+  doi = {10.48550/arXiv.2502.13595},
+}
+
+@article{muennighoff2022mteb,
+  author = {Muennighoff, Niklas and Tazi, Nouamane and Magne, Lo{\"\i}c and Reimers, Nils},
+  title = {MTEB: Massive Text Embedding Benchmark},
+  publisher = {arXiv},
+  journal={arXiv preprint arXiv:2210.07316},
+  year = {2022}
+  url = {https://arxiv.org/abs/2210.07316},
+  doi = {10.48550/ARXIV.2210.07316},
 }
 ```
 
-as well as the WMT 2019 paper that provided the English source data NTREX-128 is based on:
+# Dataset Statistics
+<details>
+  <summary> Dataset Statistics</summary>
+
+The following code contains the descriptive statistics from the task. These can also be obtained using:
+
+```python
+import mteb
 
+task = mteb.get_task("NTREXBitextMining")
+
+desc_stats = task.metadata.descriptive_stats
 ```
-@inproceedings{barrault-etal-2019-findings,
-    title = "Findings of the 2019 Conference on Machine Translation ({WMT}19)",
-    author = {Barrault, Lo{\"\i}c  and
-      Bojar, Ond{\v{r}}ej  and
-      Costa-juss{\`a}, Marta R.  and
-      Federmann, Christian  and
-      Fishel, Mark  and
-      Graham, Yvette  and
-      Haddow, Barry  and
-      Huck, Matthias  and
-      Koehn, Philipp  and
-      Malmasi, Shervin  and
-      Monz, Christof  and
-      M{\"u}ller, Mathias  and
-      Pal, Santanu  and
-      Post, Matt  and
-      Zampieri, Marcos},
-    editor = "Bojar, Ond{\v{r}}ej  and
-      Chatterjee, Rajen  and
-      Federmann, Christian  and
-      Fishel, Mark  and
-      Graham, Yvette  and
-      Haddow, Barry  and
-      Huck, Matthias  and
-      Yepes, Antonio Jimeno  and
-      Koehn, Philipp  and
-      Martins, Andr{\'e}  and
-      Monz, Christof  and
-      Negri, Matteo  and
-      N{\'e}v{\'e}ol, Aur{\'e}lie  and
-      Neves, Mariana  and
-      Post, Matt  and
-      Turchi, Marco  and
-      Verspoor, Karin",
-    booktitle = "Proceedings of the Fourth Conference on Machine Translation (Volume 2: Shared Task Papers, Day 1)",
-    month = aug,
-    year = "2019",
-    address = "Florence, Italy",
-    publisher = "Association for Computational Linguistics",
-    url = "https://aclanthology.org/W19-5301",
-    doi = "10.18653/v1/W19-5301",
-    pages = "1--61",
+
+```json
+{
+    "test": {
+        "num_samples": 3826252,
+        "number_of_characters": 988355274,
+        "unique_pairs": 3820263,
+        "min_sentence1_length": 1,
+        "average_sentence1_length": 129.15449296073547,
+        "max_sentence1_length": 773,
+        "unique_sentence1": 241259,
+        "min_sentence2_length": 1,
+        "average_sentence2_length": 129.15449296073547,
+        "max_sentence2_length": 773,
+        "unique_sentence2": 241259
+    }
 }
-```
+```
+
+</details>
+
+---
+*This dataset card was automatically generated using [MTEB](https://github.com/embeddings-benchmark/mteb)*