upload ct2 model

README.md

@@ -1,3 +1,95 @@
----
-license: mit
----
+---
+license: mit
+language:
+- gl
+- es
+- en
+- eu
+- ca
+metrics:
+- bleu average (Flores): 25.1
+---
+
+**English text [here](https://huggingface.co/proxectonos/NOS-MT-OpenNMT-gl-es/blob/main/README_English.md)**
+
+**Descrición do Modelo** 
+
+Modelo feito con OpenNMT-py 3.2 para as línguas do Reino de España e inglés utilizando unha arquitectura transformer. O modelo foi transformado para o formato da ctranslate2.
+
+**Como usar este Modelo**
+
++ Instalar o [Python 3.9](https://www.python.org/downloads/release/python-390/) 
++ Instalar o [ctranslate 3.2](https://github.com/OpenNMT/CTranslate2)
++ Instalar o subword_nmt:
+```bash
+    pip install subword-nmt
+```
++ Traducir un input.txt utilizando o modelo cos seguintes comandos:
+```bash
+    perl tokenizer.perl < input.txt > input.tok
+```
+```bash
+    subword_nmt.apply_bpe -c ./bpe/es.bpe < input.tok > input.bpe
+```
+```bash 
+    python3 translate.py ./ct2-multi input.bpe > output.txt
+```
+```bash
+    ': sed -i 's/@@ //g' output.txt
+```
+
+**Adestramento**
+
+No adestramento, utilizamos córpora auténticos e sintéticos do [ProxectoNós](https://github.com/proxectonos/corpora). Os primeiros son córpora de traducións feitas directamente por tradutores humanos. É importante salientar que a pesar destes textos seren feitos por humanos, non están libres de erros lingüísticos. Os segundos son córpora de traducións español-portugués, que convertemos en español-galego a través da tradución automática portugués-galego con Opentrad/Apertium e transliteración para palabras fóra de vocabulario.
+
+**Procedemento de adestramento**
+
++ Tokenización dos datasets feita co tokenizador (tokenizer.pl) de [linguakit](https://github.com/citiususc/Linguakit) que foi modificado para evitar o salto de liña por token do ficheiro orixinal. 
+
++ O vocabulario BPE para os modelos foi xerado a través do script [learn_bpe.py](https://github.com/OpenNMT/OpenNMT-py/blob/master/tools/learn_bpe.py) da OpenNMT
+
+
+**Avaliación**
+
+A avaliación BLEU dos modelos é feita cunha mistura de tests desenvolvidos internamente (gold1, gold2, test-suite) con outros datasets disponíbeis en galego (Flores).
+
+| ca-en | ca-es | ca-eu | ca-gl | en-ca | en-es | en-eu | en-gl | es-ca | es-en | es-eu | eu-es | es-gl | eu-ca | eu-en | eu-gl | gl-ca | gl-en | gl-es | gl-eu | AVERAGE |
+|----------|----------|----------|----------|----------|----------|----------|----------|----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|
+| 39.6     | 23.6     | 16.3     | 30.9     | 39.8     | 24.5     | 18.6     | 31.9     | 22.9     | 24.6      | 13.0      | 17.8      | 22.0      | 23.0      | 26.1      | 21.5      | 30.9      | 34.9      | 23.7      | 16.4      | 25.1      |
+**Licenzas do Modelo** 
+
+MIT License
+
+Copyright (c) 2023 Proxecto Nós
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+**Financiamento** 
+
+Esta investigación foi financiada polo proxecto "Nós: o galego na sociedade e economía da intelixencia artificial", resultado dun acordo entre a Xunta de Galicia e a Universidade de Santiago de Compostela, o que resultou no subsidio ED431G2019/04 da Consellaría de Educación, Universidade e Formación Profesional da Galiza, e polo Fondo Europeo de Desenvolvemento Rexional (programa ERDF/FEDER), e Grupos de Referencia: ED431C 2020/21.  
+
+**Citar este traballo** 
+
+Se utilizar este modelo no seu traballo, cite por favor así:
+
+Daniel Bardanca Outeirinho, Pablo Gamallo Otero, Iria de-Dios-Flores, and José Ramom Pichel Campos. 2024.
+Exploring the effects of vocabulary size in neural machine translation: Galician as a target language.
+In Proceedings of the 16th International Conference on Computational Processing of Portuguese, pages 600–604,
+Santiago de Compostela, Galiza. Association for Computational Lingustics.
+

README_English.md

@@ -0,0 +1,94 @@
+---
+license: mit
+language:
+- gl
+- es
+- en
+- eu
+- ca
+metrics:
+- bleu average (Flores): 25.1
+---
+
+**English text [here](https://huggingface.co/proxectonos/NOS-MT-OpenNMT-gl-es/blob/main/README_English.md)**
+
+**Model Description** 
+
+Model created with OpenNMT-py 3.2 for the languages of the Kingdom of Spain and English using a transformer architecture. The model was converted to the ctranslate2 format.
+
+**How to Use This Model**
+
++ Install [Python 3.9](https://www.python.org/downloads/release/python-390/) 
++ Install [ctranslate 3.2](https://github.com/OpenNMT/CTranslate2)
++ Install subword_nmt:
+```bash
+    pip install subword-nmt
+```
++ Translate an input.txt using the model with the following commands:
+```bash
+    perl tokenizer.perl < input.txt > input.tok
+```
+```bash
+    subword_nmt.apply_bpe -c ./bpe/es.bpe < input.tok > input.bpe
+```
+```bash 
+    python3 translate.py ./ct2-multi input.bpe > output.txt
+```
+```bash
+    ': sed -i 's/@@ //g' output.txt
+```
+
+**Training**
+
+In the training, we used authentic and synthetic corpora from the [ProxectoNós](https://github.com/proxectonos/corpora). The former are corpora of translations made directly by human translators. It is important to note that despite these texts being made by humans, they are not free from linguistic errors. The latter are corpora of Spanish-Portuguese translations, which we converted into Spanish-Galician through Portuguese-Galician automatic translation with Opentrad/Apertium and transliteration for out-of-vocabulary words.
+
+**Training Procedure**
+
++ Tokenization of the datasets was done with the tokenizer (tokenizer.pl) from [linguakit](https://github.com/citiususc/Linguakit) which was modified to avoid line breaks per token from the original file. 
+
++ The BPE vocabulary for the models was generated through the [learn_bpe.py](https://github.com/OpenNMT/OpenNMT-py/blob/master/tools/learn_bpe.py) script from OpenNMT.
+
+
+**Evaluation**
+
+The BLEU evaluation of the models is done with a mix of internally developed tests (gold1, gold2, test-suite) and other available datasets in Galician (Flores).
+
+| ca-en | ca-es | ca-eu | ca-gl | en-ca | en-es | en-eu | en-gl | es-ca | es-en | es-eu | eu-es | es-gl | eu-ca | eu-en | eu-gl | gl-ca | gl-en | gl-es | gl-eu | AVERAGE |
+|----------|----------|----------|----------|----------|----------|----------|----------|----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|
+| 39.6     | 23.6     | 16.3     | 30.9     | 39.8     | 24.5     | 18.6     | 31.9     | 22.9     | 24.6      | 13.0      | 17.8      | 22.0      | 23.0      | 26.1      | 21.5      | 30.9      | 34.9      | 23.7      | 16.4      | 25.1      |
+**Model Licenses** 
+
+MIT License
+
+Copyright (c) 2023 Proxecto Nós
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+**Funding** 
+
+This research was funded by the project "Nós: Galician in the society and economy of artificial intelligence", resulting from an agreement between the Xunta de Galicia and the University of Santiago de Compostela, which resulted in the ED431G2019/04 grant from the Consellería de Educación, Universidade e Formación Profesional da Galiza, and by the European Regional Development Fund (ERDF/FEDER program), and Reference Groups: ED431C 2020/21.  
+
+**Cite This Work** 
+
+If you use this model in your work, please cite it as follows:
+
+Daniel Bardanca Outeirinho, Pablo Gamallo Otero, Iria de-Dios-Flores, and José Ramom Pichel Campos. 2024.
+Exploring the effects of vocabulary size in neural machine translation: Galician as a target language.
+In Proceedings of the 16th International Conference on Computational Processing of Portuguese, pages 600–604,
+Santiago de Compostela, Galiza. Association for Computational Linguistics.

ct2-multi/config.json

@@ -0,0 +1,10 @@
+{
+  "add_source_bos": false,
+  "add_source_eos": false,
+  "bos_token": "<s>",
+  "decoder_start_token": "<s>",
+  "eos_token": "</s>",
+  "layer_norm_epsilon": null,
+  "multi_query_attention": false,
+  "unk_token": "<unk>"
+}

ct2-multi/model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5637a1be4a22a0ef6934336d893ab7e9432e0fb2263f4b1f98de8f0164efa312
+size 471529833