tiedeman commited on
Commit
4d47578
1 Parent(s): bdca8a4

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,219 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: transformers
3
+ language:
4
+ - acf
5
+ - an
6
+ - ast
7
+ - ca
8
+ - cbk
9
+ - co
10
+ - egl
11
+ - en
12
+ - es
13
+ - ext
14
+ - fr
15
+ - frm
16
+ - frp
17
+ - fur
18
+ - gcf
19
+ - gl
20
+ - ht
21
+ - it
22
+ - kea
23
+ - lad
24
+ - lij
25
+ - lld
26
+ - lmo
27
+ - lou
28
+ - mfe
29
+ - mo
30
+ - mwl
31
+ - nap
32
+ - oc
33
+ - osp
34
+ - pap
35
+ - pms
36
+ - pt
37
+ - rm
38
+ - ro
39
+ - rup
40
+ - sc
41
+ - scn
42
+ - vec
43
+ - wa
44
+
45
+ tags:
46
+ - translation
47
+ - opus-mt-tc-bible
48
+
49
+ license: apache-2.0
50
+ model-index:
51
+ - name: opus-mt-tc-bible-big-roa-en
52
+ results:
53
+ - task:
54
+ name: Translation multi-eng
55
+ type: translation
56
+ args: multi-eng
57
+ dataset:
58
+ name: tatoeba-test-v2020-07-28-v2023-09-26
59
+ type: tatoeba_mt
60
+ args: multi-eng
61
+ metrics:
62
+ - name: BLEU
63
+ type: bleu
64
+ value: 62.8
65
+ - name: chr-F
66
+ type: chrf
67
+ value: 0.76737
68
+ ---
69
+ # opus-mt-tc-bible-big-roa-en
70
+
71
+ ## Table of Contents
72
+ - [Model Details](#model-details)
73
+ - [Uses](#uses)
74
+ - [Risks, Limitations and Biases](#risks-limitations-and-biases)
75
+ - [How to Get Started With the Model](#how-to-get-started-with-the-model)
76
+ - [Training](#training)
77
+ - [Evaluation](#evaluation)
78
+ - [Citation Information](#citation-information)
79
+ - [Acknowledgements](#acknowledgements)
80
+
81
+ ## Model Details
82
+
83
+ Neural machine translation model for translating from Romance languages (roa) to English (en).
84
+
85
+ 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).
86
+ **Model Description:**
87
+ - **Developed by:** Language Technology Research Group at the University of Helsinki
88
+ - **Model Type:** Translation (transformer-big)
89
+ - **Release**: 2024-08-17
90
+ - **License:** Apache-2.0
91
+ - **Language(s):**
92
+ - Source Language(s): acf arg ast cat cbk cos egl ext fra frm frp fur gcf glg hat ita kea lad lij lld lmo lou mfe mol mwl nap oci osp pap pms por roh ron rup scn spa srd vec wln
93
+ - Target Language(s): eng
94
+ - **Original Model**: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/roa-eng/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip)
95
+ - **Resources for more information:**
96
+ - [OPUS-MT dashboard](https://opus.nlpl.eu/dashboard/index.php?pkg=opusmt&test=all&scoreslang=all&chart=standard&model=Tatoeba-MT-models/roa-eng/opusTCv20230926max50%2Bbt%2Bjhubc_transformer-big_2024-08-17)
97
+ - [OPUS-MT-train GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
98
+ - [More information about MarianNMT models in the transformers library](https://huggingface.co/docs/transformers/model_doc/marian)
99
+ - [Tatoeba Translation Challenge](https://github.com/Helsinki-NLP/Tatoeba-Challenge/)
100
+ - [HPLT bilingual data v1 (as part of the Tatoeba Translation Challenge dataset)](https://hplt-project.org/datasets/v1)
101
+ - [A massively parallel Bible corpus](https://aclanthology.org/L14-1215/)
102
+
103
+ ## Uses
104
+
105
+ This model can be used for translation and text-to-text generation.
106
+
107
+ ## Risks, Limitations and Biases
108
+
109
+ **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.**
110
+
111
+ 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)).
112
+
113
+ ## How to Get Started With the Model
114
+
115
+ A short example code:
116
+
117
+ ```python
118
+ from transformers import MarianMTModel, MarianTokenizer
119
+
120
+ src_text = [
121
+ "É caro demais.",
122
+ "Estamos muertos."
123
+ ]
124
+
125
+ model_name = "pytorch-models/opus-mt-tc-bible-big-roa-en"
126
+ tokenizer = MarianTokenizer.from_pretrained(model_name)
127
+ model = MarianMTModel.from_pretrained(model_name)
128
+ translated = model.generate(**tokenizer(src_text, return_tensors="pt", padding=True))
129
+
130
+ for t in translated:
131
+ print( tokenizer.decode(t, skip_special_tokens=True) )
132
+
133
+ # expected output:
134
+ # It's too expensive.
135
+ # We're dead.
136
+ ```
137
+
138
+ You can also use OPUS-MT models with the transformers pipelines, for example:
139
+
140
+ ```python
141
+ from transformers import pipeline
142
+ pipe = pipeline("translation", model="Helsinki-NLP/opus-mt-tc-bible-big-roa-en")
143
+ print(pipe("É caro demais."))
144
+
145
+ # expected output: It's too expensive.
146
+ ```
147
+
148
+ ## Training
149
+
150
+ - **Data**: opusTCv20230926max50+bt+jhubc ([source](https://github.com/Helsinki-NLP/Tatoeba-Challenge))
151
+ - **Pre-processing**: SentencePiece (spm32k,spm32k)
152
+ - **Model Type:** transformer-big
153
+ - **Original MarianNMT Model**: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/roa-eng/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip)
154
+ - **Training Scripts**: [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
155
+
156
+ ## Evaluation
157
+
158
+ * [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/roa-eng/opusTCv20230926max50%2Bbt%2Bjhubc_transformer-big_2024-08-17)
159
+ * test set translations: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.test.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/roa-eng/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.test.txt)
160
+ * test set scores: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.eval.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/roa-eng/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.eval.txt)
161
+ * benchmark results: [benchmark_results.txt](benchmark_results.txt)
162
+ * benchmark output: [benchmark_translations.zip](benchmark_translations.zip)
163
+
164
+ | langpair | testset | chr-F | BLEU | #sent | #words |
165
+ |----------|---------|-------|-------|-------|--------|
166
+ | multi-eng | tatoeba-test-v2020-07-28-v2023-09-26 | 0.76737 | 62.8 | 10000 | 87576 |
167
+
168
+ ## Citation Information
169
+
170
+ * 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.)
171
+
172
+ ```bibtex
173
+ @article{tiedemann2023democratizing,
174
+ title={Democratizing neural machine translation with {OPUS-MT}},
175
+ 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},
176
+ journal={Language Resources and Evaluation},
177
+ number={58},
178
+ pages={713--755},
179
+ year={2023},
180
+ publisher={Springer Nature},
181
+ issn={1574-0218},
182
+ doi={10.1007/s10579-023-09704-w}
183
+ }
184
+
185
+ @inproceedings{tiedemann-thottingal-2020-opus,
186
+ title = "{OPUS}-{MT} {--} Building open translation services for the World",
187
+ author = {Tiedemann, J{\"o}rg and Thottingal, Santhosh},
188
+ booktitle = "Proceedings of the 22nd Annual Conference of the European Association for Machine Translation",
189
+ month = nov,
190
+ year = "2020",
191
+ address = "Lisboa, Portugal",
192
+ publisher = "European Association for Machine Translation",
193
+ url = "https://aclanthology.org/2020.eamt-1.61",
194
+ pages = "479--480",
195
+ }
196
+
197
+ @inproceedings{tiedemann-2020-tatoeba,
198
+ title = "The Tatoeba Translation Challenge {--} Realistic Data Sets for Low Resource and Multilingual {MT}",
199
+ author = {Tiedemann, J{\"o}rg},
200
+ booktitle = "Proceedings of the Fifth Conference on Machine Translation",
201
+ month = nov,
202
+ year = "2020",
203
+ address = "Online",
204
+ publisher = "Association for Computational Linguistics",
205
+ url = "https://aclanthology.org/2020.wmt-1.139",
206
+ pages = "1174--1182",
207
+ }
208
+ ```
209
+
210
+ ## Acknowledgements
211
+
212
+ 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/).
213
+
214
+ ## Model conversion info
215
+
216
+ * transformers version: 4.45.1
217
+ * OPUS-MT git hash: 0882077
218
+ * port time: Tue Oct 8 15:26:36 EEST 2024
219
+ * 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.76737 62.8 10000 87576
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-roa-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": 55522,
17
+ "decoder_vocab_size": 55523,
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": 771,
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": 55522,
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": 55523
41
+ }
generation_config.json ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_from_model_config": true,
3
+ "bad_words_ids": [
4
+ [
5
+ 55522
6
+ ]
7
+ ],
8
+ "bos_token_id": 0,
9
+ "decoder_start_token_id": 55522,
10
+ "eos_token_id": 771,
11
+ "forced_eos_token_id": 771,
12
+ "max_length": 512,
13
+ "num_beams": 4,
14
+ "pad_token_id": 55522,
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:4266334d15e1d8b427aabd21d68c4c73b1feab2dd7a0160b4651b1663751a3b0
3
+ size 933103420
pytorch_model.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:cd2e6207aa5e9f2de90ace3df85a9833c00dd708e39ce88ef76d830f2aab7ff9
3
+ size 933154693
source.spm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:adda68b5bfa9a3dd63794193af5423933eb86896aa2be1f4f8a750994dbee140
3
+ size 808605
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:c3ce42eb9d1ca0b2c7926be6b80e3391a86ed2d8291e0982cc2509f65f8d2953
3
+ size 799586
tokenizer_config.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"source_lang": "roa", "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/roa-en", "tokenizer_class": "MarianTokenizer"}
vocab.json ADDED
The diff for this file is too large to render. See raw diff