tiedeman commited on
Commit
47304ea
1 Parent(s): 1cad5ac

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,215 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - da
4
+ - gmq
5
+ - he
6
+ - no
7
+
8
+ tags:
9
+ - translation
10
+ - opus-mt-tc
11
+
12
+ license: cc-by-4.0
13
+ model-index:
14
+ - name: opus-mt-tc-big-gmq-he
15
+ results:
16
+ - task:
17
+ name: Translation dan-heb
18
+ type: translation
19
+ args: dan-heb
20
+ dataset:
21
+ name: flores101-devtest
22
+ type: flores_101
23
+ args: dan heb devtest
24
+ metrics:
25
+ - name: BLEU
26
+ type: bleu
27
+ value: 22.9
28
+ - name: chr-F
29
+ type: chrf
30
+ value: 0.52815
31
+ - task:
32
+ name: Translation isl-heb
33
+ type: translation
34
+ args: isl-heb
35
+ dataset:
36
+ name: flores101-devtest
37
+ type: flores_101
38
+ args: isl heb devtest
39
+ metrics:
40
+ - name: BLEU
41
+ type: bleu
42
+ value: 14.2
43
+ - name: chr-F
44
+ type: chrf
45
+ value: 0.42284
46
+ - task:
47
+ name: Translation nob-heb
48
+ type: translation
49
+ args: nob-heb
50
+ dataset:
51
+ name: flores101-devtest
52
+ type: flores_101
53
+ args: nob heb devtest
54
+ metrics:
55
+ - name: BLEU
56
+ type: bleu
57
+ value: 19.2
58
+ - name: chr-F
59
+ type: chrf
60
+ value: 0.49492
61
+ - task:
62
+ name: Translation swe-heb
63
+ type: translation
64
+ args: swe-heb
65
+ dataset:
66
+ name: flores101-devtest
67
+ type: flores_101
68
+ args: swe heb devtest
69
+ metrics:
70
+ - name: BLEU
71
+ type: bleu
72
+ value: 23.0
73
+ - name: chr-F
74
+ type: chrf
75
+ value: 0.52408
76
+ ---
77
+ # opus-mt-tc-big-gmq-he
78
+
79
+ ## Table of Contents
80
+ - [Model Details](#model-details)
81
+ - [Uses](#uses)
82
+ - [Risks, Limitations and Biases](#risks-limitations-and-biases)
83
+ - [How to Get Started With the Model](#how-to-get-started-with-the-model)
84
+ - [Training](#training)
85
+ - [Evaluation](#evaluation)
86
+ - [Citation Information](#citation-information)
87
+ - [Acknowledgements](#acknowledgements)
88
+
89
+ ## Model Details
90
+
91
+ Neural machine translation model for translating from North Germanic languages (gmq) to Hebrew (he).
92
+
93
+ 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).
94
+ **Model Description:**
95
+ - **Developed by:** Language Technology Research Group at the University of Helsinki
96
+ - **Model Type:** Translation (transformer-big)
97
+ - **Release**: 2022-07-28
98
+ - **License:** CC-BY-4.0
99
+ - **Language(s):**
100
+ - Source Language(s): dan nor
101
+ - Target Language(s): heb
102
+ - **Original Model**: [opusTCv20210807_transformer-big_2022-07-28.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/gmq-heb/opusTCv20210807_transformer-big_2022-07-28.zip)
103
+ - **Resources for more information:**
104
+ - [OPUS-MT-train GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
105
+ - More information about released models for this language pair: [OPUS-MT gmq-heb README](https://github.com/Helsinki-NLP/Tatoeba-Challenge/tree/master/models/gmq-heb/README.md)
106
+ - [More information about MarianNMT models in the transformers library](https://huggingface.co/docs/transformers/model_doc/marian)
107
+ - [Tatoeba Translation Challenge](https://github.com/Helsinki-NLP/Tatoeba-Challenge/
108
+
109
+ ## Uses
110
+
111
+ This model can be used for translation and text-to-text generation.
112
+
113
+ ## Risks, Limitations and Biases
114
+
115
+ **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.**
116
+
117
+ 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)).
118
+
119
+ ## How to Get Started With the Model
120
+
121
+ A short example code:
122
+
123
+ ```python
124
+ from transformers import MarianMTModel, MarianTokenizer
125
+
126
+ src_text = [
127
+ "Alle L.L. Zamenhofs tre børn blev myrdet i holocausten.",
128
+ "Tom visade sig vara spion."
129
+ ]
130
+
131
+ model_name = "pytorch-models/opus-mt-tc-big-gmq-he"
132
+ tokenizer = MarianTokenizer.from_pretrained(model_name)
133
+ model = MarianMTModel.from_pretrained(model_name)
134
+ translated = model.generate(**tokenizer(src_text, return_tensors="pt", padding=True))
135
+
136
+ for t in translated:
137
+ print( tokenizer.decode(t, skip_special_tokens=True) )
138
+
139
+ # expected output:
140
+ # כל שלושת הילדים של אל-אל זאמנהוף נרצחו בשואה.
141
+ # מסתבר שטום היה מרגל.
142
+ ```
143
+
144
+ You can also use OPUS-MT models with the transformers pipelines, for example:
145
+
146
+ ```python
147
+ from transformers import pipeline
148
+ pipe = pipeline("translation", model="Helsinki-NLP/opus-mt-tc-big-gmq-he")
149
+ print(pipe("Alle L.L. Zamenhofs tre børn blev myrdet i holocausten."))
150
+
151
+ # expected output: כל שלושת הילדים של אל-אל זאמנהוף נרצחו בשואה.
152
+ ```
153
+
154
+ ## Training
155
+
156
+ - **Data**: opusTCv20210807 ([source](https://github.com/Helsinki-NLP/Tatoeba-Challenge))
157
+ - **Pre-processing**: SentencePiece (spm32k,spm32k)
158
+ - **Model Type:** transformer-big
159
+ - **Original MarianNMT Model**: [opusTCv20210807_transformer-big_2022-07-28.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/gmq-heb/opusTCv20210807_transformer-big_2022-07-28.zip)
160
+ - **Training Scripts**: [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
161
+
162
+ ## Evaluation
163
+
164
+ * test set translations: [opusTCv20210807_transformer-big_2022-07-28.test.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/gmq-heb/opusTCv20210807_transformer-big_2022-07-28.test.txt)
165
+ * test set scores: [opusTCv20210807_transformer-big_2022-07-28.eval.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/gmq-heb/opusTCv20210807_transformer-big_2022-07-28.eval.txt)
166
+ * benchmark results: [benchmark_results.txt](benchmark_results.txt)
167
+ * benchmark output: [benchmark_translations.zip](benchmark_translations.zip)
168
+
169
+ | langpair | testset | chr-F | BLEU | #sent | #words |
170
+ |----------|---------|-------|-------|-------|--------|
171
+ | dan-heb | flores101-devtest | 0.52815 | 22.9 | 1012 | 20749 |
172
+ | isl-heb | flores101-devtest | 0.42284 | 14.2 | 1012 | 20749 |
173
+ | nob-heb | flores101-devtest | 0.49492 | 19.2 | 1012 | 20749 |
174
+ | swe-heb | flores101-devtest | 0.52408 | 23.0 | 1012 | 20749 |
175
+
176
+ ## Citation Information
177
+
178
+ * 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.)
179
+
180
+ ```
181
+ @inproceedings{tiedemann-thottingal-2020-opus,
182
+ title = "{OPUS}-{MT} {--} Building open translation services for the World",
183
+ author = {Tiedemann, J{\"o}rg and Thottingal, Santhosh},
184
+ booktitle = "Proceedings of the 22nd Annual Conference of the European Association for Machine Translation",
185
+ month = nov,
186
+ year = "2020",
187
+ address = "Lisboa, Portugal",
188
+ publisher = "European Association for Machine Translation",
189
+ url = "https://aclanthology.org/2020.eamt-1.61",
190
+ pages = "479--480",
191
+ }
192
+
193
+ @inproceedings{tiedemann-2020-tatoeba,
194
+ title = "The Tatoeba Translation Challenge {--} Realistic Data Sets for Low Resource and Multilingual {MT}",
195
+ author = {Tiedemann, J{\"o}rg},
196
+ booktitle = "Proceedings of the Fifth Conference on Machine Translation",
197
+ month = nov,
198
+ year = "2020",
199
+ address = "Online",
200
+ publisher = "Association for Computational Linguistics",
201
+ url = "https://aclanthology.org/2020.wmt-1.139",
202
+ pages = "1174--1182",
203
+ }
204
+ ```
205
+
206
+ ## Acknowledgements
207
+
208
+ 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.
209
+
210
+ ## Model conversion info
211
+
212
+ * transformers version: 4.16.2
213
+ * OPUS-MT git hash: 8b9f0b0
214
+ * port time: Fri Aug 12 16:43:58 EEST 2022
215
+ * port machine: LM0-400-22516.local
benchmark_results.txt ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
1
+ dan-heb flores101-dev 0.52736 22.8 997 19946
2
+ isl-heb flores101-dev 0.42277 14.1 997 19946
3
+ nob-heb flores101-dev 0.48796 18.5 997 19946
4
+ swe-heb flores101-dev 0.52231 22.9 997 19946
5
+ dan-heb flores101-devtest 0.52815 22.9 1012 20749
6
+ isl-heb flores101-devtest 0.42284 14.2 1012 20749
7
+ nob-heb flores101-devtest 0.49492 19.2 1012 20749
8
+ swe-heb flores101-devtest 0.52408 23.0 1012 20749
benchmark_translations.zip ADDED
@@ -0,0 +1,3 @@
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:bc5ddb9eabbd82d1311cf3c85a35da17bb9d8e6da814d51020df271bfb6315a3
3
+ size 1330144
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
+ 60012
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": 60012,
21
+ "decoder_vocab_size": 60013,
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": 23695,
28
+ "forced_eos_token_id": 23695,
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": 60012,
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": 60013
45
+ }
pytorch_model.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:93207e4741d02cf4b2ada076a042f3c82836618aa8e8ed2e3327ec8a88299b86
3
+ size 598739715
source.spm ADDED
@@ -0,0 +1,3 @@
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:8ed15e8c9acfe88511b47a0a47100385c778c55344d3eb471a9a160fa4476c62
3
+ size 789199
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:23d7bfde9c8099815ca772f6689081a85c14a6e3b9d12c28fe4dab48952527fd
3
+ size 876269
tokenizer_config.json ADDED
@@ -0,0 +1 @@
 
1
+ {"source_lang": "gmq", "target_lang": "he", "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-28/gmq-he", "tokenizer_class": "MarianTokenizer"}
vocab.json ADDED
The diff for this file is too large to render. See raw diff