tiedeman commited on
Commit
726da07
1 Parent(s): 8c19ffd

Initial commit

Browse files
.gitattributes CHANGED
@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ *.spm filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,195 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: transformers
3
+ language:
4
+ - am
5
+ - ar
6
+ - arc
7
+ - en
8
+ - hbo
9
+ - he
10
+ - jpa
11
+ - mt
12
+ - oar
13
+ - phn
14
+ - sgw
15
+ - syc
16
+ - syr
17
+ - ti
18
+ - tig
19
+ - tmr
20
+
21
+ tags:
22
+ - translation
23
+ - opus-mt-tc-bible
24
+
25
+ license: apache-2.0
26
+ model-index:
27
+ - name: opus-mt-tc-bible-big-sem-en
28
+ results:
29
+ - task:
30
+ name: Translation multi-eng
31
+ type: translation
32
+ args: multi-eng
33
+ dataset:
34
+ name: tatoeba-test-v2020-07-28-v2023-09-26
35
+ type: tatoeba_mt
36
+ args: multi-eng
37
+ metrics:
38
+ - name: BLEU
39
+ type: bleu
40
+ value: 48.5
41
+ - name: chr-F
42
+ type: chrf
43
+ value: 0.64511
44
+ ---
45
+ # opus-mt-tc-bible-big-sem-en
46
+
47
+ ## Table of Contents
48
+ - [Model Details](#model-details)
49
+ - [Uses](#uses)
50
+ - [Risks, Limitations and Biases](#risks-limitations-and-biases)
51
+ - [How to Get Started With the Model](#how-to-get-started-with-the-model)
52
+ - [Training](#training)
53
+ - [Evaluation](#evaluation)
54
+ - [Citation Information](#citation-information)
55
+ - [Acknowledgements](#acknowledgements)
56
+
57
+ ## Model Details
58
+
59
+ Neural machine translation model for translating from Semitic languages (sem) to English (en).
60
+
61
+ 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).
62
+ **Model Description:**
63
+ - **Developed by:** Language Technology Research Group at the University of Helsinki
64
+ - **Model Type:** Translation (transformer-big)
65
+ - **Release**: 2024-08-17
66
+ - **License:** Apache-2.0
67
+ - **Language(s):**
68
+ - Source Language(s): acm afb amh apc ara arc arq arz hbo heb jpa mlt oar phn sgw syc syr tig tir tmr
69
+ - Target Language(s): eng
70
+ - **Original Model**: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/sem-eng/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip)
71
+ - **Resources for more information:**
72
+ - [OPUS-MT dashboard](https://opus.nlpl.eu/dashboard/index.php?pkg=opusmt&test=all&scoreslang=all&chart=standard&model=Tatoeba-MT-models/sem-eng/opusTCv20230926max50%2Bbt%2Bjhubc_transformer-big_2024-08-17)
73
+ - [OPUS-MT-train GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
74
+ - [More information about MarianNMT models in the transformers library](https://huggingface.co/docs/transformers/model_doc/marian)
75
+ - [Tatoeba Translation Challenge](https://github.com/Helsinki-NLP/Tatoeba-Challenge/)
76
+ - [HPLT bilingual data v1 (as part of the Tatoeba Translation Challenge dataset)](https://hplt-project.org/datasets/v1)
77
+ - [A massively parallel Bible corpus](https://aclanthology.org/L14-1215/)
78
+
79
+ ## Uses
80
+
81
+ This model can be used for translation and text-to-text generation.
82
+
83
+ ## Risks, Limitations and Biases
84
+
85
+ **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.**
86
+
87
+ 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)).
88
+
89
+ ## How to Get Started With the Model
90
+
91
+ A short example code:
92
+
93
+ ```python
94
+ from transformers import MarianMTModel, MarianTokenizer
95
+
96
+ src_text = [
97
+ "تعال لتأخذنا.",
98
+ "ربما سيغير رأيه."
99
+ ]
100
+
101
+ model_name = "pytorch-models/opus-mt-tc-bible-big-sem-en"
102
+ tokenizer = MarianTokenizer.from_pretrained(model_name)
103
+ model = MarianMTModel.from_pretrained(model_name)
104
+ translated = model.generate(**tokenizer(src_text, return_tensors="pt", padding=True))
105
+
106
+ for t in translated:
107
+ print( tokenizer.decode(t, skip_special_tokens=True) )
108
+
109
+ # expected output:
110
+ # Come and get us.
111
+ # Maybe he'll change his mind.
112
+ ```
113
+
114
+ You can also use OPUS-MT models with the transformers pipelines, for example:
115
+
116
+ ```python
117
+ from transformers import pipeline
118
+ pipe = pipeline("translation", model="Helsinki-NLP/opus-mt-tc-bible-big-sem-en")
119
+ print(pipe("تعال لتأخذنا."))
120
+
121
+ # expected output: Come and get us.
122
+ ```
123
+
124
+ ## Training
125
+
126
+ - **Data**: opusTCv20230926max50+bt+jhubc ([source](https://github.com/Helsinki-NLP/Tatoeba-Challenge))
127
+ - **Pre-processing**: SentencePiece (spm32k,spm32k)
128
+ - **Model Type:** transformer-big
129
+ - **Original MarianNMT Model**: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/sem-eng/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip)
130
+ - **Training Scripts**: [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
131
+
132
+ ## Evaluation
133
+
134
+ * [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/sem-eng/opusTCv20230926max50%2Bbt%2Bjhubc_transformer-big_2024-08-17)
135
+ * test set translations: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.test.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/sem-eng/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.test.txt)
136
+ * test set scores: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.eval.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/sem-eng/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.eval.txt)
137
+ * benchmark results: [benchmark_results.txt](benchmark_results.txt)
138
+ * benchmark output: [benchmark_translations.zip](benchmark_translations.zip)
139
+
140
+ | langpair | testset | chr-F | BLEU | #sent | #words |
141
+ |----------|---------|-------|-------|-------|--------|
142
+ | multi-eng | tatoeba-test-v2020-07-28-v2023-09-26 | 0.64511 | 48.5 | 10000 | 71553 |
143
+
144
+ ## Citation Information
145
+
146
+ * 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.)
147
+
148
+ ```bibtex
149
+ @article{tiedemann2023democratizing,
150
+ title={Democratizing neural machine translation with {OPUS-MT}},
151
+ 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},
152
+ journal={Language Resources and Evaluation},
153
+ number={58},
154
+ pages={713--755},
155
+ year={2023},
156
+ publisher={Springer Nature},
157
+ issn={1574-0218},
158
+ doi={10.1007/s10579-023-09704-w}
159
+ }
160
+
161
+ @inproceedings{tiedemann-thottingal-2020-opus,
162
+ title = "{OPUS}-{MT} {--} Building open translation services for the World",
163
+ author = {Tiedemann, J{\"o}rg and Thottingal, Santhosh},
164
+ booktitle = "Proceedings of the 22nd Annual Conference of the European Association for Machine Translation",
165
+ month = nov,
166
+ year = "2020",
167
+ address = "Lisboa, Portugal",
168
+ publisher = "European Association for Machine Translation",
169
+ url = "https://aclanthology.org/2020.eamt-1.61",
170
+ pages = "479--480",
171
+ }
172
+
173
+ @inproceedings{tiedemann-2020-tatoeba,
174
+ title = "The Tatoeba Translation Challenge {--} Realistic Data Sets for Low Resource and Multilingual {MT}",
175
+ author = {Tiedemann, J{\"o}rg},
176
+ booktitle = "Proceedings of the Fifth Conference on Machine Translation",
177
+ month = nov,
178
+ year = "2020",
179
+ address = "Online",
180
+ publisher = "Association for Computational Linguistics",
181
+ url = "https://aclanthology.org/2020.wmt-1.139",
182
+ pages = "1174--1182",
183
+ }
184
+ ```
185
+
186
+ ## Acknowledgements
187
+
188
+ 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/).
189
+
190
+ ## Model conversion info
191
+
192
+ * transformers version: 4.45.1
193
+ * OPUS-MT git hash: 0882077
194
+ * port time: Tue Oct 8 17:06:04 EEST 2024
195
+ * port machine: LM0-400-22516.local
benchmark_results.txt ADDED
@@ -0,0 +1 @@
 
 
1
+ multi-eng tatoeba-test-v2020-07-28-v2023-09-26 0.64511 48.5 10000 71553
benchmark_translations.zip ADDED
File without changes
config.json ADDED
@@ -0,0 +1,41 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "pytorch-models/opus-mt-tc-bible-big-sem-en",
3
+ "activation_dropout": 0.0,
4
+ "activation_function": "relu",
5
+ "architectures": [
6
+ "MarianMTModel"
7
+ ],
8
+ "attention_dropout": 0.0,
9
+ "bos_token_id": 0,
10
+ "classifier_dropout": 0.0,
11
+ "d_model": 1024,
12
+ "decoder_attention_heads": 16,
13
+ "decoder_ffn_dim": 4096,
14
+ "decoder_layerdrop": 0.0,
15
+ "decoder_layers": 6,
16
+ "decoder_start_token_id": 61022,
17
+ "decoder_vocab_size": 61023,
18
+ "dropout": 0.1,
19
+ "encoder_attention_heads": 16,
20
+ "encoder_ffn_dim": 4096,
21
+ "encoder_layerdrop": 0.0,
22
+ "encoder_layers": 6,
23
+ "eos_token_id": 928,
24
+ "forced_eos_token_id": null,
25
+ "init_std": 0.02,
26
+ "is_encoder_decoder": true,
27
+ "max_length": null,
28
+ "max_position_embeddings": 1024,
29
+ "model_type": "marian",
30
+ "normalize_embedding": false,
31
+ "num_beams": null,
32
+ "num_hidden_layers": 6,
33
+ "pad_token_id": 61022,
34
+ "scale_embedding": true,
35
+ "share_encoder_decoder_embeddings": true,
36
+ "static_position_embeddings": true,
37
+ "torch_dtype": "float32",
38
+ "transformers_version": "4.45.1",
39
+ "use_cache": true,
40
+ "vocab_size": 61023
41
+ }
generation_config.json ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_from_model_config": true,
3
+ "bad_words_ids": [
4
+ [
5
+ 61022
6
+ ]
7
+ ],
8
+ "bos_token_id": 0,
9
+ "decoder_start_token_id": 61022,
10
+ "eos_token_id": 928,
11
+ "forced_eos_token_id": 928,
12
+ "max_length": 512,
13
+ "num_beams": 4,
14
+ "pad_token_id": 61022,
15
+ "transformers_version": "4.45.1"
16
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:37b87c1bdaa76309a1e9fce89842d0d3740b24e8c255a1993a58e839ca188c43
3
+ size 955653420
pytorch_model.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:c05051c2ae8beb1e5c4c929046cecbecc7b2c95ccc3ad619355e824a88ffac04
3
+ size 955704645
source.spm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:4027f4026e47c9ade0b5dde7d4ffc2f662b0ca832c062d43d7cef521fb6cea71
3
+ size 848358
special_tokens_map.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"eos_token": "</s>", "unk_token": "<unk>", "pad_token": "<pad>"}
target.spm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:4fd6a59a41075b1f42d514de1da61a3b419c61f95342b5dd0dbff73f37317086
3
+ size 804382
tokenizer_config.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"source_lang": "sem", "target_lang": "en", "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-17/sem-en", "tokenizer_class": "MarianTokenizer"}
vocab.json ADDED
The diff for this file is too large to render. See raw diff