Initial commit

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+*.spm filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,194 @@
+---
+library_name: transformers
+language:
+- bru
+- cmo
+- de
+- en
+- kha
+- km
+- kxm
+- mnw
+- ngt
+- nl
+- vi
+- wbm
+
+tags:
+- translation
+- opus-mt-tc-bible
+
+license: apache-2.0
+model-index:
+- name: opus-mt-tc-bible-big-mkh-deu_eng_nld
+  results:
+  - task:
+      name: Translation multi-multi
+      type: translation
+      args: multi-multi
+    dataset:
+      name: tatoeba-test-v2020-07-28-v2023-09-26
+      type: tatoeba_mt
+      args: multi-multi
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 28.4
+       - name: chr-F
+         type: chrf
+         value: 0.46593
+---
+# opus-mt-tc-bible-big-mkh-deu_eng_nld
+
+## Table of Contents
+- [Model Details](#model-details)
+- [Uses](#uses)
+- [Risks, Limitations and Biases](#risks-limitations-and-biases)
+- [How to Get Started With the Model](#how-to-get-started-with-the-model)
+- [Training](#training)
+- [Evaluation](#evaluation)
+- [Citation Information](#citation-information)
+- [Acknowledgements](#acknowledgements)
+
+## Model Details
+
+Neural machine translation model for translating from Mon-Khmer languages (mkh) to unknown (deu+eng+nld).
+
+This model is part of the [OPUS-MT project](https://github.com/Helsinki-NLP/Opus-MT), an effort to make neural machine translation models widely available and accessible for many languages in the world. All models are originally trained using the amazing framework of [Marian NMT](https://marian-nmt.github.io/), an efficient NMT implementation written in pure C++. The models have been converted to pyTorch using the transformers library by huggingface. Training data is taken from [OPUS](https://opus.nlpl.eu/) and training pipelines use the procedures of [OPUS-MT-train](https://github.com/Helsinki-NLP/Opus-MT-train).
+**Model Description:**
+- **Developed by:** Language Technology Research Group at the University of Helsinki
+- **Model Type:** Translation (transformer-big)
+- **Release**: 2024-08-18
+- **License:** Apache-2.0
+- **Language(s):**  
+  - Source Language(s): bru cmo kha khm kxm mnw ngt vie wbm
+  - Target Language(s): deu eng nld
+  - Valid Target Language Labels: >>deu<< >>eng<< >>nld<< >>xxx<<
+- **Original Model**: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/mkh-deu+eng+nld/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18.zip)
+- **Resources for more information:**
+  -  [OPUS-MT dashboard](https://opus.nlpl.eu/dashboard/index.php?pkg=opusmt&test=all&scoreslang=all&chart=standard&model=Tatoeba-MT-models/mkh-deu%2Beng%2Bnld/opusTCv20230926max50%2Bbt%2Bjhubc_transformer-big_2024-08-18)
+  - [OPUS-MT-train GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
+  - [More information about MarianNMT models in the transformers library](https://huggingface.co/docs/transformers/model_doc/marian)
+  - [Tatoeba Translation Challenge](https://github.com/Helsinki-NLP/Tatoeba-Challenge/)
+  - [HPLT bilingual data v1 (as part of the Tatoeba Translation Challenge dataset)](https://hplt-project.org/datasets/v1)
+  - [A massively parallel Bible corpus](https://aclanthology.org/L14-1215/)
+
+This is a multilingual translation model with multiple target languages. A sentence initial language token is required in the form of `>>id<<` (id = valid target language ID), e.g. `>>deu<<`
+
+## Uses
+
+This model can be used for translation and text-to-text generation.
+
+## Risks, Limitations and Biases
+
+**CONTENT WARNING: Readers should be aware that the model is trained on various public data sets that may contain content that is disturbing, offensive, and can propagate historical and current stereotypes.**
+
+Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)).
+
+## How to Get Started With the Model
+
+A short example code:
+
+```python
+from transformers import MarianMTModel, MarianTokenizer
+
+src_text = [
+    ">>eng<< Kumba katno sngi men don ha Boston?",
+    ">>eng<< "Không" là số đứng đằng trước "một"."
+]
+
+model_name = "pytorch-models/opus-mt-tc-bible-big-mkh-deu_eng_nld"
+tokenizer = MarianTokenizer.from_pretrained(model_name)
+model = MarianMTModel.from_pretrained(model_name)
+translated = model.generate(**tokenizer(src_text, return_tensors="pt", padding=True))
+
+for t in translated:
+    print( tokenizer.decode(t, skip_special_tokens=True) )
+
+# expected output:
+#     Kumba katno sngi men don ha Boston?
+#     “No” is the number in front of “one”.
+```
+
+You can also use OPUS-MT models with the transformers pipelines, for example:
+
+```python
+from transformers import pipeline
+pipe = pipeline("translation", model="Helsinki-NLP/opus-mt-tc-bible-big-mkh-deu_eng_nld")
+print(pipe(">>eng<< Kumba katno sngi men don ha Boston?"))
+
+# expected output: Kumba katno sngi men don ha Boston?
+```
+
+## Training
+
+- **Data**: opusTCv20230926max50+bt+jhubc ([source](https://github.com/Helsinki-NLP/Tatoeba-Challenge))
+- **Pre-processing**: SentencePiece (spm32k,spm32k)
+- **Model Type:**  transformer-big
+- **Original MarianNMT Model**: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/mkh-deu+eng+nld/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18.zip)
+- **Training Scripts**: [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
+
+## Evaluation
+
+* [Model scores at the OPUS-MT dashboard](https://opus.nlpl.eu/dashboard/index.php?pkg=opusmt&test=all&scoreslang=all&chart=standard&model=Tatoeba-MT-models/mkh-deu%2Beng%2Bnld/opusTCv20230926max50%2Bbt%2Bjhubc_transformer-big_2024-08-18)
+* test set translations: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18.test.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/mkh-deu+eng+nld/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18.test.txt)
+* test set scores: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18.eval.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/mkh-deu+eng+nld/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18.eval.txt)
+* benchmark results: [benchmark_results.txt](benchmark_results.txt)
+* benchmark output: [benchmark_translations.zip](benchmark_translations.zip)
+
+| langpair | testset | chr-F | BLEU  | #sent | #words |
+|----------|---------|-------|-------|-------|--------|
+| multi-multi | tatoeba-test-v2020-07-28-v2023-09-26 | 0.46593 | 28.4 | 5015 | 36727 |
+
+## Citation Information
+
+* Publications: [Democratizing neural machine translation with OPUS-MT](https://doi.org/10.1007/s10579-023-09704-w) and [OPUS-MT – Building open translation services for the World](https://aclanthology.org/2020.eamt-1.61/) and [The Tatoeba Translation Challenge – Realistic Data Sets for Low Resource and Multilingual MT](https://aclanthology.org/2020.wmt-1.139/) (Please, cite if you use this model.)
+
+```bibtex
+@article{tiedemann2023democratizing,
+  title={Democratizing neural machine translation with {OPUS-MT}},
+  author={Tiedemann, J{\"o}rg and Aulamo, Mikko and Bakshandaeva, Daria and Boggia, Michele and Gr{\"o}nroos, Stig-Arne and Nieminen, Tommi and Raganato, Alessandro and Scherrer, Yves and Vazquez, Raul and Virpioja, Sami},
+  journal={Language Resources and Evaluation},
+  number={58},
+  pages={713--755},
+  year={2023},
+  publisher={Springer Nature},
+  issn={1574-0218},
+  doi={10.1007/s10579-023-09704-w}
+}
+
+@inproceedings{tiedemann-thottingal-2020-opus,
+    title = "{OPUS}-{MT} {--} Building open translation services for the World",
+    author = {Tiedemann, J{\"o}rg  and Thottingal, Santhosh},
+    booktitle = "Proceedings of the 22nd Annual Conference of the European Association for Machine Translation",
+    month = nov,
+    year = "2020",
+    address = "Lisboa, Portugal",
+    publisher = "European Association for Machine Translation",
+    url = "https://aclanthology.org/2020.eamt-1.61",
+    pages = "479--480",
+}
+
+@inproceedings{tiedemann-2020-tatoeba,
+    title = "The Tatoeba Translation Challenge {--} Realistic Data Sets for Low Resource and Multilingual {MT}",
+    author = {Tiedemann, J{\"o}rg},
+    booktitle = "Proceedings of the Fifth Conference on Machine Translation",
+    month = nov,
+    year = "2020",
+    address = "Online",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2020.wmt-1.139",
+    pages = "1174--1182",
+}
+```
+
+## Acknowledgements
+
+The work is supported by the [HPLT project](https://hplt-project.org/), funded by the European Union’s Horizon Europe research and innovation programme under grant agreement No 101070350. We are also grateful for the generous computational resources and IT infrastructure provided by [CSC -- IT Center for Science](https://www.csc.fi/), Finland, and the [EuroHPC supercomputer LUMI](https://www.lumi-supercomputer.eu/).
+
+## Model conversion info
+
+* transformers version: 4.45.1
+* OPUS-MT git hash: 0882077
+* port time: Tue Oct  8 12:14:07 EEST 2024
+* port machine: LM0-400-22516.local

benchmark_results.txt

@@ -0,0 +1 @@
+multi-multi	tatoeba-test-v2020-07-28-v2023-09-26	0.46593	28.4	5015	36727

config.json

@@ -0,0 +1,41 @@
+{
+  "_name_or_path": "pytorch-models/opus-mt-tc-bible-big-mkh-deu_eng_nld",
+  "activation_dropout": 0.0,
+  "activation_function": "relu",
+  "architectures": [
+    "MarianMTModel"
+  ],
+  "attention_dropout": 0.0,
+  "bos_token_id": 0,
+  "classifier_dropout": 0.0,
+  "d_model": 1024,
+  "decoder_attention_heads": 16,
+  "decoder_ffn_dim": 4096,
+  "decoder_layerdrop": 0.0,
+  "decoder_layers": 6,
+  "decoder_start_token_id": 55467,
+  "decoder_vocab_size": 55468,
+  "dropout": 0.1,
+  "encoder_attention_heads": 16,
+  "encoder_ffn_dim": 4096,
+  "encoder_layerdrop": 0.0,
+  "encoder_layers": 6,
+  "eos_token_id": 1045,
+  "forced_eos_token_id": null,
+  "init_std": 0.02,
+  "is_encoder_decoder": true,
+  "max_length": null,
+  "max_position_embeddings": 1024,
+  "model_type": "marian",
+  "normalize_embedding": false,
+  "num_beams": null,
+  "num_hidden_layers": 6,
+  "pad_token_id": 55467,
+  "scale_embedding": true,
+  "share_encoder_decoder_embeddings": true,
+  "static_position_embeddings": true,
+  "torch_dtype": "float32",
+  "transformers_version": "4.45.1",
+  "use_cache": true,
+  "vocab_size": 55468
+}

generation_config.json

@@ -0,0 +1,16 @@
+{
+  "_from_model_config": true,
+  "bad_words_ids": [
+    [
+      55467
+    ]
+  ],
+  "bos_token_id": 0,
+  "decoder_start_token_id": 55467,
+  "eos_token_id": 1045,
+  "forced_eos_token_id": 1045,
+  "max_length": 512,
+  "num_beams": 4,
+  "pad_token_id": 55467,
+  "transformers_version": "4.45.1"
+}

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1a3b13452d7258c8d81ba8070c3bfa65360c73d1faed17184cee14b421d1cd99
+size 932877920

pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5e31940c0308cfb2b162cee8dbd5c68182b4cfb81a0abd3df8e105fdd0652c34
+size 932929157

source.spm

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:60b486c765d8feac10c92e4305c6635530c029fa144d32952c716eaa651d7e61
+size 877589

special_tokens_map.json

@@ -0,0 +1 @@
+{"eos_token": "</s>", "unk_token": "<unk>", "pad_token": "<pad>"}

target.spm

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a819f2003f7cd92fb60f5e99a403c30f4a4630a58ba9020b3192d0026e9064b3
+size 806026

tokenizer_config.json

@@ -0,0 +1 @@
+{"source_lang": "mkh", "target_lang": "deu+eng+nld", "unk_token": "<unk>", "eos_token": "</s>", "pad_token": "<pad>", "model_max_length": 512, "sp_model_kwargs": {}, "separate_vocabs": false, "special_tokens_map_file": null, "name_or_path": "marian-models/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-18/mkh-deu+eng+nld", "tokenizer_class": "MarianTokenizer"}