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,252 @@
+---
+language:
+- es
+- fa
+- fr
+- it
+- itc
+- pt
+
+tags:
+- translation
+- opus-mt-tc
+
+license: cc-by-4.0
+model-index:
+- name: opus-mt-tc-big-fa-itc
+  results:
+  - task:
+      name: Translation fas-fra
+      type: translation
+      args: fas-fra
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: fas fra devtest
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 28.9
+       - name: chr-F
+         type: chrf
+         value: 0.55883
+  - task:
+      name: Translation fas-ita
+      type: translation
+      args: fas-ita
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: fas ita devtest
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 19.7
+       - name: chr-F
+         type: chrf
+         value: 0.49512
+  - task:
+      name: Translation fas-por
+      type: translation
+      args: fas-por
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: fas por devtest
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 27.6
+       - name: chr-F
+         type: chrf
+         value: 0.54829
+  - task:
+      name: Translation fas-ron
+      type: translation
+      args: fas-ron
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: fas ron devtest
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 19.7
+       - name: chr-F
+         type: chrf
+         value: 0.48821
+  - task:
+      name: Translation fas-spa
+      type: translation
+      args: fas-spa
+    dataset:
+      name: flores101-devtest
+      type: flores_101
+      args: fas spa devtest
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 19.4
+       - name: chr-F
+         type: chrf
+         value: 0.47722
+  - task:
+      name: Translation fas-fra
+      type: translation
+      args: fas-fra
+    dataset:
+      name: tatoeba-test-v2021-08-07
+      type: tatoeba_mt
+      args: fas-fra
+    metrics:
+       - name: BLEU
+         type: bleu
+         value: 37.5
+       - name: chr-F
+         type: chrf
+         value: 0.57949
+---
+# opus-mt-tc-big-fa-itc
+
+## 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 Persian (fa) to Italic languages (itc).
+
+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-07-23
+- **License:** CC-BY-4.0
+- **Language(s):**  
+  - Source Language(s): fas
+  - Target Language(s): fra ita por spa
+  - Valid Target Language Labels: >>fra<< >>ita<< >>por<< >>spa<<
+- **Original Model**: [opusTCv20210807_transformer-big_2022-07-23.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/fas-itc/opusTCv20210807_transformer-big_2022-07-23.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 fas-itc README](https://github.com/Helsinki-NLP/Tatoeba-Challenge/tree/master/models/fas-itc/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. `>>fra<<`
+
+## 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 = [
+    ">>lad<< اسلام زیباست.",
+    ">>spa<< ورود به کتابخانه رایگان است."
+]
+
+model_name = "pytorch-models/opus-mt-tc-big-fa-itc"
+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:
+#     O Islam é lindo.
+#     La entrada a la biblioteca es gratuita.
+```
+
+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-fa-itc")
+print(pipe(">>lad<< اسلام زیباست."))
+
+# expected output: O Islam é lindo.
+```
+
+## 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-07-23.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/fas-itc/opusTCv20210807_transformer-big_2022-07-23.zip)
+- **Training Scripts**: [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
+
+## Evaluation
+
+* test set translations: [opusTCv20210807_transformer-big_2022-07-23.test.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/fas-itc/opusTCv20210807_transformer-big_2022-07-23.test.txt)
+* test set scores: [opusTCv20210807_transformer-big_2022-07-23.eval.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/fas-itc/opusTCv20210807_transformer-big_2022-07-23.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 |
+|----------|---------|-------|-------|-------|--------|
+| fas-fra | tatoeba-test-v2021-08-07 | 0.57949 | 37.5 | 376 | 3377 |
+| fas-fra | flores101-devtest | 0.55883 | 28.9 | 1012 | 28343 |
+| fas-ita | flores101-devtest | 0.49512 | 19.7 | 1012 | 27306 |
+| fas-por | flores101-devtest | 0.54829 | 27.6 | 1012 | 26519 |
+| fas-ron | flores101-devtest | 0.48821 | 19.7 | 1012 | 26799 |
+| fas-spa | flores101-devtest | 0.47722 | 19.4 | 1012 | 29199 |
+
+## 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 20:02:14 EEST 2022
+* port machine: LM0-400-22516.local

benchmark_results.txt

@@ -0,0 +1,13 @@
+fas-fra	flores101-dev	0.56248	29.3	997	26706
+fas-ita	flores101-dev	0.49919	19.8	997	25840
+fas-por	flores101-dev	0.54764	27.6	997	25287
+fas-ron	flores101-dev	0.48837	20.0	997	25616
+fas-spa	flores101-dev	0.46962	19.0	997	27793
+fas-fra	flores101-devtest	0.55883	28.9	1012	28343
+fas-ita	flores101-devtest	0.49512	19.7	1012	27306
+fas-por	flores101-devtest	0.54829	27.6	1012	26519
+fas-ron	flores101-devtest	0.48821	19.7	1012	26799
+fas-spa	flores101-devtest	0.47722	19.4	1012	29199
+fas-fra	tatoeba-test-v2020-07-28	0.57910	37.5	375	3371
+fas-fra	tatoeba-test-v2021-03-30	0.58078	37.6	383	3442
+fas-fra	tatoeba-test-v2021-08-07	0.57949	37.5	376	3377

benchmark_translations.zip

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

config.json

@@ -0,0 +1,45 @@
+{
+  "activation_dropout": 0.0,
+  "activation_function": "relu",
+  "architectures": [
+    "MarianMTModel"
+  ],
+  "attention_dropout": 0.0,
+  "bad_words_ids": [
+    [
+      60707
+    ]
+  ],
+  "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": 60707,
+  "decoder_vocab_size": 60708,
+  "dropout": 0.1,
+  "encoder_attention_heads": 16,
+  "encoder_ffn_dim": 4096,
+  "encoder_layerdrop": 0.0,
+  "encoder_layers": 6,
+  "eos_token_id": 28803,
+  "forced_eos_token_id": 28803,
+  "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": 60707,
+  "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": 60708
+}

pytorch_model.bin

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

source.spm

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

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:7a85e9cbe146a4dd7bb0a39500d455fe3c44ff2ee3a018a6d2c1e85845b6db50
+size 810253

tokenizer_config.json

@@ -0,0 +1 @@
+{"source_lang": "fa", "target_lang": "itc", "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-07-23/fa-itc", "tokenizer_class": "MarianTokenizer"}