Update README.md

README.md

@@ -1,3 +1,90 @@
----
-license: mit
----
+---
+license: mit
+language:
+- pt
+- gl
+metrics:
+- bleu (floresdev): 25.6
+- bleu (floredevtest): 25.4
+- bleu (ntrex): 25.1
+---
+
+**Descrición do Modelo** 
+
+Modelo feito con OpenNMT-py 3.2 para o par português-galego utilizando unha arquitectura transformer. O modelo foi transformado para o formato da ctranslate2.
+
+**Como traducir con este Modelo**
+
++ Instalar o [Python 3.9](https://www.python.org/downloads/release/python-390/) 
++ Traducir un input_text utilizando o modelo nos-coda_iacobus-pt-gl 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-es-gl_12L 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
+
++ Utilizando o .yaml deste repositorio pode replicar o proceso de adestramento. É preciso modificar os paths do ficheiro .yaml para a Open NMT saber onde ir buscar os textos. Após facer isto, pode do seguinte xeito comezar o proceso:
+
+```bash 
+onmt_build_vocab -config  pt-gl.yaml -n_sample 35000
+onmt_train -config pt-gl.yaml
+```
+
+**Hiperparámetros** 
+
+Os parámetros usados para o desenvolvemento do modelo poden ser consultados directamente no mesmo ficheiro .yaml  pt-gl.yaml 
+
+**Avaliación**
+
+A avaliación BLEU dos modelos é feita sobre os testes máis utilizados (Flores_dev, Flores_devtest, Ntrex).
+
+| FLORES_DEV| FLORES_DEVTEST | NTREX   | 
+| --------- |:----------    :| -------:|
+| 25.6      | 25.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** 
+
+This model was developed within the Nós Project, funded by the Ministerio para la Transformación Digital y de la Función Pública - Funded by EU – NextGenerationEU within the framework of the [project ILENIA] (https://proyectoilenia.es/) with reference 2022/TL22/00215336. 
+
+