tiedeman commited on
Commit
5459129
1 Parent(s): ac8d850

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,189 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: transformers
3
+ language:
4
+ - de
5
+ - en
6
+ - lt
7
+ - lv
8
+ - nl
9
+ - prg
10
+ - sgs
11
+
12
+ tags:
13
+ - translation
14
+ - opus-mt-tc-bible
15
+
16
+ license: apache-2.0
17
+ model-index:
18
+ - name: opus-mt-tc-bible-big-bat-deu_eng_nld
19
+ results:
20
+ - task:
21
+ name: Translation multi-multi
22
+ type: translation
23
+ args: multi-multi
24
+ dataset:
25
+ name: tatoeba-test-v2020-07-28-v2023-09-26
26
+ type: tatoeba_mt
27
+ args: multi-multi
28
+ metrics:
29
+ - name: BLEU
30
+ type: bleu
31
+ value: 56.9
32
+ - name: chr-F
33
+ type: chrf
34
+ value: 0.72041
35
+ ---
36
+ # opus-mt-tc-bible-big-bat-deu_eng_nld
37
+
38
+ ## Table of Contents
39
+ - [Model Details](#model-details)
40
+ - [Uses](#uses)
41
+ - [Risks, Limitations and Biases](#risks-limitations-and-biases)
42
+ - [How to Get Started With the Model](#how-to-get-started-with-the-model)
43
+ - [Training](#training)
44
+ - [Evaluation](#evaluation)
45
+ - [Citation Information](#citation-information)
46
+ - [Acknowledgements](#acknowledgements)
47
+
48
+ ## Model Details
49
+
50
+ Neural machine translation model for translating from Baltic languages (bat) to unknown (deu+eng+nld).
51
+
52
+ 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).
53
+ **Model Description:**
54
+ - **Developed by:** Language Technology Research Group at the University of Helsinki
55
+ - **Model Type:** Translation (transformer-big)
56
+ - **Release**: 2024-08-17
57
+ - **License:** Apache-2.0
58
+ - **Language(s):**
59
+ - Source Language(s): lav lit prg sgs
60
+ - Target Language(s): deu eng nld
61
+ - Valid Target Language Labels: >>deu<< >>eng<< >>nld<< >>xxx<<
62
+ - **Original Model**: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/bat-deu+eng+nld/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip)
63
+ - **Resources for more information:**
64
+ - [OPUS-MT dashboard](https://opus.nlpl.eu/dashboard/index.php?pkg=opusmt&test=all&scoreslang=all&chart=standard&model=Tatoeba-MT-models/bat-deu%2Beng%2Bnld/opusTCv20230926max50%2Bbt%2Bjhubc_transformer-big_2024-08-17)
65
+ - [OPUS-MT-train GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
66
+ - [More information about MarianNMT models in the transformers library](https://huggingface.co/docs/transformers/model_doc/marian)
67
+ - [Tatoeba Translation Challenge](https://github.com/Helsinki-NLP/Tatoeba-Challenge/)
68
+ - [HPLT bilingual data v1 (as part of the Tatoeba Translation Challenge dataset)](https://hplt-project.org/datasets/v1)
69
+ - [A massively parallel Bible corpus](https://aclanthology.org/L14-1215/)
70
+
71
+ 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. `>>deu<<`
72
+
73
+ ## Uses
74
+
75
+ This model can be used for translation and text-to-text generation.
76
+
77
+ ## Risks, Limitations and Biases
78
+
79
+ **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.**
80
+
81
+ 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)).
82
+
83
+ ## How to Get Started With the Model
84
+
85
+ A short example code:
86
+
87
+ ```python
88
+ from transformers import MarianMTModel, MarianTokenizer
89
+
90
+ src_text = [
91
+ ">>deu<< 1991. gadā neatkarību pasludināja Horvātija, Slovēnija un Maķedonija, kam 1992. gadā sekoja Bosnija.",
92
+ ">>eng<< Jukiko mėgsta bulves."
93
+ ]
94
+
95
+ model_name = "pytorch-models/opus-mt-tc-bible-big-bat-deu_eng_nld"
96
+ tokenizer = MarianTokenizer.from_pretrained(model_name)
97
+ model = MarianMTModel.from_pretrained(model_name)
98
+ translated = model.generate(**tokenizer(src_text, return_tensors="pt", padding=True))
99
+
100
+ for t in translated:
101
+ print( tokenizer.decode(t, skip_special_tokens=True) )
102
+
103
+ # expected output:
104
+ # 1991 erklärten Kroatien, Slowenien und Mazedonien ihre Unabhängigkeit, 1992 folgte Bosnien.
105
+ # Yukiko likes potatoes.
106
+ ```
107
+
108
+ You can also use OPUS-MT models with the transformers pipelines, for example:
109
+
110
+ ```python
111
+ from transformers import pipeline
112
+ pipe = pipeline("translation", model="Helsinki-NLP/opus-mt-tc-bible-big-bat-deu_eng_nld")
113
+ print(pipe(">>deu<< 1991. gadā neatkarību pasludināja Horvātija, Slovēnija un Maķedonija, kam 1992. gadā sekoja Bosnija."))
114
+
115
+ # expected output: 1991 erklärten Kroatien, Slowenien und Mazedonien ihre Unabhängigkeit, 1992 folgte Bosnien.
116
+ ```
117
+
118
+ ## Training
119
+
120
+ - **Data**: opusTCv20230926max50+bt+jhubc ([source](https://github.com/Helsinki-NLP/Tatoeba-Challenge))
121
+ - **Pre-processing**: SentencePiece (spm32k,spm32k)
122
+ - **Model Type:** transformer-big
123
+ - **Original MarianNMT Model**: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip](https://object.pouta.csc.fi/Tatoeba-MT-models/bat-deu+eng+nld/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.zip)
124
+ - **Training Scripts**: [GitHub Repo](https://github.com/Helsinki-NLP/OPUS-MT-train)
125
+
126
+ ## Evaluation
127
+
128
+ * [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/bat-deu%2Beng%2Bnld/opusTCv20230926max50%2Bbt%2Bjhubc_transformer-big_2024-08-17)
129
+ * test set translations: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.test.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/bat-deu+eng+nld/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.test.txt)
130
+ * test set scores: [opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.eval.txt](https://object.pouta.csc.fi/Tatoeba-MT-models/bat-deu+eng+nld/opusTCv20230926max50+bt+jhubc_transformer-big_2024-08-17.eval.txt)
131
+ * benchmark results: [benchmark_results.txt](benchmark_results.txt)
132
+ * benchmark output: [benchmark_translations.zip](benchmark_translations.zip)
133
+
134
+ | langpair | testset | chr-F | BLEU | #sent | #words |
135
+ |----------|---------|-------|-------|-------|--------|
136
+ | multi-multi | tatoeba-test-v2020-07-28-v2023-09-26 | 0.72041 | 56.9 | 5531 | 39520 |
137
+
138
+ ## Citation Information
139
+
140
+ * 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.)
141
+
142
+ ```bibtex
143
+ @article{tiedemann2023democratizing,
144
+ title={Democratizing neural machine translation with {OPUS-MT}},
145
+ 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},
146
+ journal={Language Resources and Evaluation},
147
+ number={58},
148
+ pages={713--755},
149
+ year={2023},
150
+ publisher={Springer Nature},
151
+ issn={1574-0218},
152
+ doi={10.1007/s10579-023-09704-w}
153
+ }
154
+
155
+ @inproceedings{tiedemann-thottingal-2020-opus,
156
+ title = "{OPUS}-{MT} {--} Building open translation services for the World",
157
+ author = {Tiedemann, J{\"o}rg and Thottingal, Santhosh},
158
+ booktitle = "Proceedings of the 22nd Annual Conference of the European Association for Machine Translation",
159
+ month = nov,
160
+ year = "2020",
161
+ address = "Lisboa, Portugal",
162
+ publisher = "European Association for Machine Translation",
163
+ url = "https://aclanthology.org/2020.eamt-1.61",
164
+ pages = "479--480",
165
+ }
166
+
167
+ @inproceedings{tiedemann-2020-tatoeba,
168
+ title = "The Tatoeba Translation Challenge {--} Realistic Data Sets for Low Resource and Multilingual {MT}",
169
+ author = {Tiedemann, J{\"o}rg},
170
+ booktitle = "Proceedings of the Fifth Conference on Machine Translation",
171
+ month = nov,
172
+ year = "2020",
173
+ address = "Online",
174
+ publisher = "Association for Computational Linguistics",
175
+ url = "https://aclanthology.org/2020.wmt-1.139",
176
+ pages = "1174--1182",
177
+ }
178
+ ```
179
+
180
+ ## Acknowledgements
181
+
182
+ 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/).
183
+
184
+ ## Model conversion info
185
+
186
+ * transformers version: 4.45.1
187
+ * OPUS-MT git hash: a0ea3b3
188
+ * port time: Mon Oct 7 19:54:57 EEST 2024
189
+ * port machine: LM0-400-22516.local
benchmark_results.txt ADDED
@@ -0,0 +1 @@
 
 
1
+ multi-multi tatoeba-test-v2020-07-28-v2023-09-26 0.72041 56.9 5531 39520
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-bat-deu_eng_nld",
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": 59090,
17
+ "decoder_vocab_size": 59091,
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": 981,
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": 59090,
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": 59091
41
+ }
generation_config.json ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_from_model_config": true,
3
+ "bad_words_ids": [
4
+ [
5
+ 59090
6
+ ]
7
+ ],
8
+ "bos_token_id": 0,
9
+ "decoder_start_token_id": 59090,
10
+ "eos_token_id": 981,
11
+ "forced_eos_token_id": 981,
12
+ "max_length": 512,
13
+ "num_beams": 4,
14
+ "pad_token_id": 59090,
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:091ba4bdf0790c0d2722bd343307195e23f3aac2d0d6f6f27824d3cf8472ee26
3
+ size 947732220
pytorch_model.bin ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a3ccf037f26a80b1cbd5da471692cbcf2c6d54a9045fe0cd16f06c9022dbc5d2
3
+ size 947783493
source.spm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:65835bafaeea6794dff277045fb44232326f676ff7ab018fdf39fddc4e08794b
3
+ size 833087
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:99b43df106ae2eb45913c75790d01982719f2a2c537abad29990f9025fa5d325
3
+ size 817540
tokenizer_config.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"source_lang": "bat", "target_lang": "deu+eng+nld", "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/bat-deu+eng+nld", "tokenizer_class": "MarianTokenizer"}
vocab.json ADDED
The diff for this file is too large to render. See raw diff