Initial commit

.gitattributes

@@ -29,3 +29,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,203 @@
+---
+language:
+- ar
+- gmq
+language_bcp47:
+- ar
+- gmq
+
+tags:
+- translation
+- opus-mt-tc
+
+license: cc-by-4.0
+model-index:
+- name: opus-mt-tc-big-ar-gmq
+  results:
+  - task:
+      name: Translation ara-dan
+      type: translation
+      args: ara-dan
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: ara dan devtest
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 28.8
+       - name: chr-F
+         type: chrf
+         value: 0.56203
+  - task:
+      name: Translation ara-nob
+      type: translation
+      args: ara-nob
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: ara nob devtest
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 20.5
+       - name: chr-F
+         type: chrf
+         value: 0.50833
+  - task:
+      name: Translation ara-swe
+      type: translation
+      args: ara-swe
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: ara swe devtest
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 27.3
+       - name: chr-F
+         type: chrf
+         value: 0.55512
+---
+# opus-mt-tc-big-ar-gmq
+
+## 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 Arabic (ar) to North Germanic languages (gmq).
+
+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**: 2022-08-09
+- **License:** CC-BY-4.0
+- **Language(s):**  
+  - Source Language(s): 
+  - Target Language(s): 
+  - Valid Target Language Labels: 
+- **Original Model**: [opusTCv20210807_transformer-big_2022-08-09.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/ara-gmq/opusTCv20210807_transformer-big_2022-08-09.zip)
+- **Resources for more information:**
+  - [OPUS-MT-train GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
+  - More information about released models for this language pair: [OPUS-MT ara-gmq README](https://github.com/Helsinki-NLP/Tatoeba-Challenge/tree/master/models/ara-gmq/README.md)
+  - [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/
+
+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. `>><<`
+
+## 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 = [
+    ">>swe<< بكرا منشوف شو بدنا نعمل",
+    ">>swe<< عن ماذا يتحدث الكتاب؟"
+]
+
+model_name = "pytorch-models/opus-mt-tc-big-ar-gmq"
+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:
+#     - Vi jobbar på det.
+#     Vad handlar boken om?
+```
+
+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-big-ar-gmq")
+print(pipe(">>swe<< بكرا منشوف شو بدنا نعمل"))
+
+# expected output: - Vi jobbar på det.
+```
+
+## Training
+
+- **Data**: opusTCv20210807 ([source](https://github.com/Helsinki-NLP/Tatoeba-Challenge))
+- **Pre-processing**: SentencePiece (spm32k,spm32k)
+- **Model Type:**  transformer-big
+- **Original MarianNMT Model**: [opusTCv20210807_transformer-big_2022-08-09.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/ara-gmq/opusTCv20210807_transformer-big_2022-08-09.zip)
+- **Training Scripts**: [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
+
+## Evaluation
+
+* test set translations: [opusTCv20210807_transformer-big_2022-08-09.test.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/ara-gmq/opusTCv20210807_transformer-big_2022-08-09.test.txt)
+* test set scores: [opusTCv20210807_transformer-big_2022-08-09.eval.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/ara-gmq/opusTCv20210807_transformer-big_2022-08-09.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 |
+|----------|---------|-------|-------|-------|--------|
+| ara-dan | flores101-devtest | 0.56203 | 28.8 | 1012 | 24638 |
+| ara-nob | flores101-devtest | 0.50833 | 20.5 | 1012 | 23873 |
+| ara-swe | flores101-devtest | 0.55512 | 27.3 | 1012 | 23121 |
+
+## Citation Information
+
+* Publications: [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.)
+
+```
+@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 [European Language Grid](https://www.european-language-grid.eu/) as [pilot project 2866](https://live.european-language-grid.eu/catalogue/#/resource/projects/2866), by the [FoTran project](https://www.helsinki.fi/en/researchgroups/natural-language-understanding-with-cross-lingual-grounding), funded by the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 771113), and the [MeMAD project](https://memad.eu/), funded by the European Union’s Horizon 2020 Research and Innovation Programme under grant agreement No 780069. We are also grateful for the generous computational resources and IT infrastructure provided by [CSC -- IT Center for Science](https://www.csc.fi/), Finland.
+
+## Model conversion info
+
+* transformers version: 4.16.2
+* OPUS-MT git hash: 8b9f0b0
+* port time: Fri Aug 12 14:48:40 EEST 2022
+* port machine: LM0-400-22516.local

benchmark_results.txt

@@ -0,0 +1,6 @@
+ara-dan	flores101-dev	0.56223	29.7	997	23685
+ara-nob	flores101-dev	0.50948	21.8	997	23157
+ara-swe	flores101-dev	0.55754	28.2	997	22417
+ara-dan	flores101-devtest	0.56203	28.8	1012	24638
+ara-nob	flores101-devtest	0.50833	20.5	1012	23873
+ara-swe	flores101-devtest	0.55512	27.3	1012	23121

benchmark_translations.zip

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

config.json

@@ -0,0 +1,45 @@
+{
+  "activation_dropout": 0.0,
+  "activation_function": "relu",
+  "architectures": [
+    "MarianMTModel"
+  ],
+  "attention_dropout": 0.0,
+  "bad_words_ids": [
+    [
+      60574
+    ]
+  ],
+  "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": 60574,
+  "decoder_vocab_size": 60575,
+  "dropout": 0.1,
+  "encoder_attention_heads": 16,
+  "encoder_ffn_dim": 4096,
+  "encoder_layerdrop": 0.0,
+  "encoder_layers": 6,
+  "eos_token_id": 23935,
+  "forced_eos_token_id": 23935,
+  "init_std": 0.02,
+  "is_encoder_decoder": true,
+  "max_length": 512,
+  "max_position_embeddings": 1024,
+  "model_type": "marian",
+  "normalize_embedding": false,
+  "num_beams": 4,
+  "num_hidden_layers": 6,
+  "pad_token_id": 60574,
+  "scale_embedding": true,
+  "share_encoder_decoder_embeddings": true,
+  "static_position_embeddings": true,
+  "torch_dtype": "float16",
+  "transformers_version": "4.18.0.dev0",
+  "use_cache": true,
+  "vocab_size": 60575
+}

pytorch_model.bin

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

source.spm

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

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:585205aad3cf6089b251451336d48bed24ec753d2c4b64684c10c402c55349fe
+size 799056

tokenizer_config.json

@@ -0,0 +1 @@
+{"source_lang": "ar", "target_lang": "gmq", "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/opusTCv20210807_transformer-big_2022-08-09/ar-gmq", "tokenizer_class": "MarianTokenizer"}