tiedeman commited on
Commit
966fb9e
โ€ข
1 Parent(s): b238d65

Initial commit

Browse files
.gitattributes CHANGED
@@ -29,3 +29,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
29
  *.zip filter=lfs diff=lfs merge=lfs -text
30
  *.zst filter=lfs diff=lfs merge=lfs -text
31
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
29
  *.zip filter=lfs diff=lfs merge=lfs -text
30
  *.zst filter=lfs diff=lfs merge=lfs -text
31
  *tfevents* filter=lfs diff=lfs merge=lfs -text
32
+ *.spm filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,298 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - ar
4
+ - es
5
+ - fr
6
+ - it
7
+ - itc
8
+ - la_Latn
9
+
10
+ tags:
11
+ - translation
12
+ - opus-mt-tc
13
+
14
+ license: cc-by-4.0
15
+ model-index:
16
+ - name: opus-mt-tc-big-itc-ar
17
+ results:
18
+ - task:
19
+ name: Translation cat-ara
20
+ type: translation
21
+ args: cat-ara
22
+ dataset:
23
+ name: flores101-devtest
24
+ type: flores_101
25
+ args: cat ara devtest
26
+ metrics:
27
+ - name: BLEU
28
+ type: bleu
29
+ value: 18.9
30
+ - name: chr-F
31
+ type: chrf
32
+ value: 0.52029
33
+ - task:
34
+ name: Translation fra-ara
35
+ type: translation
36
+ args: fra-ara
37
+ dataset:
38
+ name: flores101-devtest
39
+ type: flores_101
40
+ args: fra ara devtest
41
+ metrics:
42
+ - name: BLEU
43
+ type: bleu
44
+ value: 19.5
45
+ - name: chr-F
46
+ type: chrf
47
+ value: 0.52573
48
+ - task:
49
+ name: Translation glg-ara
50
+ type: translation
51
+ args: glg-ara
52
+ dataset:
53
+ name: flores101-devtest
54
+ type: flores_101
55
+ args: glg ara devtest
56
+ metrics:
57
+ - name: BLEU
58
+ type: bleu
59
+ value: 19.2
60
+ - name: chr-F
61
+ type: chrf
62
+ value: 0.51181
63
+ - task:
64
+ name: Translation ita-ara
65
+ type: translation
66
+ args: ita-ara
67
+ dataset:
68
+ name: flores101-devtest
69
+ type: flores_101
70
+ args: ita ara devtest
71
+ metrics:
72
+ - name: BLEU
73
+ type: bleu
74
+ value: 15.0
75
+ - name: chr-F
76
+ type: chrf
77
+ value: 0.49401
78
+ - task:
79
+ name: Translation por-ara
80
+ type: translation
81
+ args: por-ara
82
+ dataset:
83
+ name: flores101-devtest
84
+ type: flores_101
85
+ args: por ara devtest
86
+ metrics:
87
+ - name: BLEU
88
+ type: bleu
89
+ value: 20.2
90
+ - name: chr-F
91
+ type: chrf
92
+ value: 0.53356
93
+ - task:
94
+ name: Translation ron-ara
95
+ type: translation
96
+ args: ron-ara
97
+ dataset:
98
+ name: flores101-devtest
99
+ type: flores_101
100
+ args: ron ara devtest
101
+ metrics:
102
+ - name: BLEU
103
+ type: bleu
104
+ value: 18.4
105
+ - name: chr-F
106
+ type: chrf
107
+ value: 0.51849
108
+ - task:
109
+ name: Translation spa-ara
110
+ type: translation
111
+ args: spa-ara
112
+ dataset:
113
+ name: flores101-devtest
114
+ type: flores_101
115
+ args: spa ara devtest
116
+ metrics:
117
+ - name: BLEU
118
+ type: bleu
119
+ value: 14.3
120
+ - name: chr-F
121
+ type: chrf
122
+ value: 0.47872
123
+ - task:
124
+ name: Translation ita-ara
125
+ type: translation
126
+ args: ita-ara
127
+ dataset:
128
+ name: tatoeba-test-v2021-08-07
129
+ type: tatoeba_mt
130
+ args: ita-ara
131
+ metrics:
132
+ - name: BLEU
133
+ type: bleu
134
+ value: 25.7
135
+ - name: chr-F
136
+ type: chrf
137
+ value: 0.53797
138
+ - task:
139
+ name: Translation spa-ara
140
+ type: translation
141
+ args: spa-ara
142
+ dataset:
143
+ name: tatoeba-test-v2021-08-07
144
+ type: tatoeba_mt
145
+ args: spa-ara
146
+ metrics:
147
+ - name: BLEU
148
+ type: bleu
149
+ value: 26.6
150
+ - name: chr-F
151
+ type: chrf
152
+ value: 0.55520
153
+ ---
154
+ # opus-mt-tc-big-itc-ar
155
+
156
+ ## Table of Contents
157
+ - [Model Details](#model-details)
158
+ - [Uses](#uses)
159
+ - [Risks, Limitations and Biases](#risks-limitations-and-biases)
160
+ - [How to Get Started With the Model](#how-to-get-started-with-the-model)
161
+ - [Training](#training)
162
+ - [Evaluation](#evaluation)
163
+ - [Citation Information](#citation-information)
164
+ - [Acknowledgements](#acknowledgements)
165
+
166
+ ## Model Details
167
+
168
+ Neural machine translation model for translating from Italic languages (itc) to Arabic (ar).
169
+
170
+ 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).
171
+ **Model Description:**
172
+ - **Developed by:** Language Technology Research Group at the University of Helsinki
173
+ - **Model Type:** Translation (transformer-big)
174
+ - **Release**: 2022-08-09
175
+ - **License:** CC-BY-4.0
176
+ - **Language(s):**
177
+ - Source Language(s): fra ita lat_Latn spa
178
+ - Target Language(s): ara
179
+ - **Original Model**: [opusTCv20210807_transformer-big_2022-08-09.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/itc-ara/opusTCv20210807_transformer-big_2022-08-09.zip)
180
+ - **Resources for more information:**
181
+ - [OPUS-MT-train GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
182
+ - More information about released models for this language pair: [OPUS-MT itc-ara README](https://github.com/Helsinki-NLP/Tatoeba-Challenge/tree/master/models/itc-ara/README.md)
183
+ - [More information about MarianNMT models in the transformers library](https://huggingface.co/docs/transformers/model_doc/marian)
184
+ - [Tatoeba Translation Challenge](https://github.com/Helsinki-NLP/Tatoeba-Challenge/
185
+
186
+ ## Uses
187
+
188
+ This model can be used for translation and text-to-text generation.
189
+
190
+ ## Risks, Limitations and Biases
191
+
192
+ **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.**
193
+
194
+ 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)).
195
+
196
+ ## How to Get Started With the Model
197
+
198
+ A short example code:
199
+
200
+ ```python
201
+ from transformers import MarianMTModel, MarianTokenizer
202
+
203
+ src_text = [
204
+ ">>ary<< Entiendo.",
205
+ ">>arq<< Por favor entiende mi posiciรณn."
206
+ ]
207
+
208
+ model_name = "pytorch-models/opus-mt-tc-big-itc-ar"
209
+ tokenizer = MarianTokenizer.from_pretrained(model_name)
210
+ model = MarianMTModel.from_pretrained(model_name)
211
+ translated = model.generate(**tokenizer(src_text, return_tensors="pt", padding=True))
212
+
213
+ for t in translated:
214
+ print( tokenizer.decode(t, skip_special_tokens=True) )
215
+
216
+ # expected output:
217
+ # ูู‡ู…ุชูƒ
218
+ # ู…ู† ูุถู„ูƒ ุงูู‡ู… ู…ูˆู‚ููŠ.
219
+ ```
220
+
221
+ You can also use OPUS-MT models with the transformers pipelines, for example:
222
+
223
+ ```python
224
+ from transformers import pipeline
225
+ pipe = pipeline("translation", model="Helsinki-NLP/opus-mt-tc-big-itc-ar")
226
+ print(pipe(">>ary<< Entiendo."))
227
+
228
+ # expected output: ูู‡ู…ุชูƒ
229
+ ```
230
+
231
+ ## Training
232
+
233
+ - **Data**: opusTCv20210807 ([source](https://github.com/Helsinki-NLP/Tatoeba-Challenge))
234
+ - **Pre-processing**: SentencePiece (spm32k,spm32k)
235
+ - **Model Type:** transformer-big
236
+ - **Original MarianNMT Model**: [opusTCv20210807_transformer-big_2022-08-09.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/itc-ara/opusTCv20210807_transformer-big_2022-08-09.zip)
237
+ - **Training Scripts**: [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
238
+
239
+ ## Evaluation
240
+
241
+ * test set translations: [opusTCv20210807_transformer-big_2022-08-09.test.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/itc-ara/opusTCv20210807_transformer-big_2022-08-09.test.txt)
242
+ * test set scores: [opusTCv20210807_transformer-big_2022-08-09.eval.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/itc-ara/opusTCv20210807_transformer-big_2022-08-09.eval.txt)
243
+ * benchmark results: [benchmark_results.txt](benchmark_results.txt)
244
+ * benchmark output: [benchmark_translations.zip](benchmark_translations.zip)
245
+
246
+ | langpair | testset | chr-F | BLEU | #sent | #words |
247
+ |----------|---------|-------|-------|-------|--------|
248
+ | fra-ara | tatoeba-test-v2021-08-07 | 0.46463 | 18.9 | 1569 | 7956 |
249
+ | ita-ara | tatoeba-test-v2021-08-07 | 0.53797 | 25.7 | 235 | 1161 |
250
+ | spa-ara | tatoeba-test-v2021-08-07 | 0.55520 | 26.6 | 1511 | 7547 |
251
+ | cat-ara | flores101-devtest | 0.52029 | 18.9 | 1012 | 21357 |
252
+ | fra-ara | flores101-devtest | 0.52573 | 19.5 | 1012 | 21357 |
253
+ | glg-ara | flores101-devtest | 0.51181 | 19.2 | 1012 | 21357 |
254
+ | ita-ara | flores101-devtest | 0.49401 | 15.0 | 1012 | 21357 |
255
+ | por-ara | flores101-devtest | 0.53356 | 20.2 | 1012 | 21357 |
256
+ | ron-ara | flores101-devtest | 0.51849 | 18.4 | 1012 | 21357 |
257
+ | spa-ara | flores101-devtest | 0.47872 | 14.3 | 1012 | 21357 |
258
+
259
+ ## Citation Information
260
+
261
+ * 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.)
262
+
263
+ ```
264
+ @inproceedings{tiedemann-thottingal-2020-opus,
265
+ title = "{OPUS}-{MT} {--} Building open translation services for the World",
266
+ author = {Tiedemann, J{\"o}rg and Thottingal, Santhosh},
267
+ booktitle = "Proceedings of the 22nd Annual Conference of the European Association for Machine Translation",
268
+ month = nov,
269
+ year = "2020",
270
+ address = "Lisboa, Portugal",
271
+ publisher = "European Association for Machine Translation",
272
+ url = "https://aclanthology.org/2020.eamt-1.61",
273
+ pages = "479--480",
274
+ }
275
+
276
+ @inproceedings{tiedemann-2020-tatoeba,
277
+ title = "The Tatoeba Translation Challenge {--} Realistic Data Sets for Low Resource and Multilingual {MT}",
278
+ author = {Tiedemann, J{\"o}rg},
279
+ booktitle = "Proceedings of the Fifth Conference on Machine Translation",
280
+ month = nov,
281
+ year = "2020",
282
+ address = "Online",
283
+ publisher = "Association for Computational Linguistics",
284
+ url = "https://aclanthology.org/2020.wmt-1.139",
285
+ pages = "1174--1182",
286
+ }
287
+ ```
288
+
289
+ ## Acknowledgements
290
+
291
+ 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.
292
+
293
+ ## Model conversion info
294
+
295
+ * transformers version: 4.16.2
296
+ * OPUS-MT git hash: 8b9f0b0
297
+ * port time: Fri Aug 12 14:32:03 EEST 2022
298
+ * port machine: LM0-400-22516.local
benchmark_results.txt ADDED
@@ -0,0 +1,18 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ cat-ara flores101-dev 0.52606 20.8 997 20512
2
+ fra-ara flores101-dev 0.52763 19.9 997 20512
3
+ glg-ara flores101-dev 0.51184 20.0 997 20512
4
+ ita-ara flores101-dev 0.49244 16.0 997 20512
5
+ por-ara flores101-dev 0.53110 20.8 997 20512
6
+ ron-ara flores101-dev 0.51521 18.7 997 20512
7
+ spa-ara flores101-dev 0.48171 14.9 997 20512
8
+ cat-ara flores101-devtest 0.52029 18.9 1012 21357
9
+ fra-ara flores101-devtest 0.52573 19.5 1012 21357
10
+ glg-ara flores101-devtest 0.51181 19.2 1012 21357
11
+ ita-ara flores101-devtest 0.49401 15.0 1012 21357
12
+ por-ara flores101-devtest 0.53356 20.2 1012 21357
13
+ ron-ara flores101-devtest 0.51849 18.4 1012 21357
14
+ spa-ara flores101-devtest 0.47872 14.3 1012 21357
15
+ ita-ara tatoeba-test-v2021-03-30 0.53296 25.5 250 1245
16
+ fra-ara tatoeba-test-v2021-08-07 0.46463 18.9 1569 7956
17
+ ita-ara tatoeba-test-v2021-08-07 0.53797 25.7 235 1161
18
+ spa-ara tatoeba-test-v2021-08-07 0.55520 26.6 1511 7547
benchmark_translations.zip ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:1ffe7fed693e0333882d7c9642fe04e5b373d991b7f46ec72f1e60c5e7d9b5d8
3
+ size 2755320
config.json ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "activation_dropout": 0.0,
3
+ "activation_function": "relu",
4
+ "architectures": [
5
+ "MarianMTModel"
6
+ ],
7
+ "attention_dropout": 0.0,
8
+ "bad_words_ids": [
9
+ [
10
+ 61502
11
+ ]
12
+ ],
13
+ "bos_token_id": 0,
14
+ "classifier_dropout": 0.0,
15
+ "d_model": 1024,
16
+ "decoder_attention_heads": 16,
17
+ "decoder_ffn_dim": 4096,
18
+ "decoder_layerdrop": 0.0,
19
+ "decoder_layers": 6,
20
+ "decoder_start_token_id": 61502,
21
+ "decoder_vocab_size": 61503,
22
+ "dropout": 0.1,
23
+ "encoder_attention_heads": 16,
24
+ "encoder_ffn_dim": 4096,
25
+ "encoder_layerdrop": 0.0,
26
+ "encoder_layers": 6,
27
+ "eos_token_id": 27389,
28
+ "forced_eos_token_id": 27389,
29
+ "init_std": 0.02,
30
+ "is_encoder_decoder": true,
31
+ "max_length": 512,
32
+ "max_position_embeddings": 1024,
33
+ "model_type": "marian",
34
+ "normalize_embedding": false,
35
+ "num_beams": 4,
36
+ "num_hidden_layers": 6,
37
+ "pad_token_id": 61502,
38
+ "scale_embedding": true,
39
+ "share_encoder_decoder_embeddings": true,
40
+ "static_position_embeddings": true,
41
+ "torch_dtype": "float16",
42
+ "transformers_version": "4.18.0.dev0",
43
+ "use_cache": true,
44
+ "vocab_size": 61503
45
+ }
pytorch_model.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:2167469a2c5a9ba2afde2d71d92ed933fdf7bd30e0c5d5c6b2d59122c98a1fa8
3
+ size 604845699
source.spm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:b25cbbab0fb29bd7b58463f5fb8197ee18669a4adf2b70ac8f6f09e4b5ac3645
3
+ size 818972
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:1c156775724de6e600cfb847b928102138c34ddaae8a447888e73681151a3fc0
3
+ size 910248
tokenizer_config.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"source_lang": "itc", "target_lang": "ar", "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/itc-ar", "tokenizer_class": "MarianTokenizer"}
vocab.json ADDED
The diff for this file is too large to render. See raw diff