Update README.md

README.md

@@ -4,56 +4,104 @@ language:
 - pt
 - gl
 metrics:
-- bleu (floresdev): 25.6
-- bleu (floredevtest): 25.4
-- bleu (ntrex): 25.1
+- bleu (Flores_dev): 25.6
+- bleu (Flores_devtest): 25.8
+- bleu (Ntrex): 24.1
 ---
+**Descrición do Modelo / Descrição do Modelo** 
 
-**Descrición do Modelo** 
+Modelo desenvolvido con OpenNMT-py 3.2 para o par portugués-galego, utilizando unha arquitectura transformer. Este modelo foi creado no ámbito dunha colaboración entre o Proxecto Nós (Universidade de Santiago de Compostela) e o CODA (Centre for Digital Culture and Innovation) da Faculdade de Letras na Universidade do Porto
 
-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.
+Modelo desenvolvido com o OpenNMT-py 3.2 para o par português-galego, utilizando uma arquitetura transformer. Este modelo foi criado no âmbito de uma colaboração entre o Projeto Nós (Universidade de Santiago de Compostela) e o CODA (Centre for Digital Culture and Innovation) da Faculdade de Letras na Universidade do Porto.
 
-**Como traducir con este Modelo**
+**Como traducir con este Modelo / Como traduzir com 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
-```
+### 🔧 Requisitos e Instalación / Requisitos e Instalação
 
-**Adestramento**
+1. Instale o [Python 3.9](https://www.python.org/downloads/release/python-390/).
+2. Instale o OpenNMT-py 3.2 seguindo as instrucións da [documentação oficial](https://opennmt.net/OpenNMT-py/).
+2. Instale o OpenNMT-py 3.2 seguindo as instruções da [documentação oficial](https://opennmt.net/OpenNMT-py/).
 
-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.
+---
+
+### 📄 Como traduzir un ficheiro con este modelo / Como traduzir um ficheiro com este modelo
+
+Estas instrucións asumen que o ficheiro de entrada se chama `por_Latn.dev` (extraído do dataset FLoRes)
+
+Estas instruções assumem que o ficheiro de entrada se chama `por_Latn.dev` (extraído do dataset FLoRes).
+
+1. **Aplicar BPE (Byte Pair Encoding)**:
+
+   ```bash
+   subword-nmt apply-bpe -c pt_35k.code < por_Latn.dev > por_Latn.dev.35k.bpe
+   ```
+
+2. **Executar a tradución co modelo / Executar a tradução com o modelo**:
+
+   ```bash
+   onmt_translate -model nos-coda_iacobus-pt-gl.pt -src por_Latn.dev.35k.bpe -output translation.txt -gpu 0 -verbose -replace_unk
+   ```
+
+3. **Limpar os marcadores BPE (@)**:
+
+   ```bash
+   sed 's/@\s*//g' translation.txt > translation.tok
+   ```
+
+4. **Detokenizar o texto traducido/traduzido**:
+
+   ```bash
+   perl detokenizer.perl < translation.tok > translation.translation
+   ```
+
+**Adestramento / Treino**
+
+No adestramento, utilizamos córpora auténticos e sintéticos obtidos a partir do [OPUS](https://opus.nlpl.eu) e do [ProxectoNós](https://github.com/proxectonos/corpora) para os pares lingüísticos relacionados co galego e o portugués.
+
+No treino, utilizámos corpora autênticos e sintéticos obtidos a partir do [OPUS](https://opus.nlpl.eu) e do [ProjetoNós](https://github.com/proxectonos/corpora), para os pares linguísticos relacionados com o galego e o português.
+
+**Procedemento de adestramento / Procedimento de treino**
+
+### ⚙️ Preparación dos datos / Preparação dos dados
+
+* A tokenización dos *datasets* foi realizada co tokenizador (`tokenizer.pl`) do [Linguakit](https://github.com/citiususc/Linguakit), modificado para evitar a inserción de quebras de liña após cada *token* no ficheiro orixinal.
+
+* A tokenização dos *datasets* foi realizada com o tokenizador (`tokenizer.pl`) do [Linguakit](https://github.com/citiususc/Linguakit), modificado para evitar a inserção de quebras de linha após cada *token* no ficheiro original.
+
+* O vocabulario BPE utilizado nos modelos foi xerado co script [`learn_bpe.py`](https://github.com/OpenNMT/OpenNMT-py/blob/master/tools/learn_bpe.py) da OpenNMT.
+
+* O vocabulário BPE utilizado nos modelos foi gerado com o script [`learn_bpe.py`](https://github.com/OpenNMT/OpenNMT-py/blob/master/tools/learn_bpe.py) da OpenNMT.
+
+### 🧪 Reproducir o adestramento / Reproduzir o treino
+
+Para obter os mesmos resultados, deben ser executadas as seguintes instrucións:
+
+Para obter os mesmos resultados, devem ser executadas as seguintes instruções:
+
+
+1. **Construír o vocabulario / Construir o vocabulário**:
 
-**Procedemento de adestramento**
+   ```bash
+   onmt_build_vocab -config pt-gl.yaml -n_sample 35000
+   ```
 
-+ 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. 
+2. **Adestrar o modelo NMT / Treinar o modelo NMT**:
 
-+ 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
+   ```bash
+   onmt_train -config pt-gl.yaml
+   ```
 
-+ 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:
+**Avaliação / Avaliación**
 
-```bash 
-onmt_build_vocab -config  pt-gl.yaml -n_sample 35000
-onmt_train -config pt-gl.yaml
-```
+A avaliación BLEU dos modelos é realizada nos seguintes datasets: Flores, Floresdevtest, Ntrex. 
 
-**Hiperparámetros** 
+A avaliação BLEU dos modelos é realizada nos seguintes datasets: Flores, Floresdevtest e Ntrex.
 
-Os parámetros usados para o desenvolvemento do modelo poden ser consultados directamente no mesmo ficheiro .yaml  pt-gl.yaml 
 
-**Avaliación**
+| Flores_dev    | Flores_devtes | Ntrex   | 
+| ------------- |:-------------:| -------:| 
+| 25.6          | 25.8          | 24.1    |
 
-A avaliación BLEU dos modelos foi feita sobre os testes máis utilizados (Flores_dev, Flores_devtest, Ntrex).
 
 **Licenzas do Modelo** 
 
@@ -81,6 +129,7 @@ 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. 
+This model was developed during a research stay at FLUP (Faculdade de Letras da Universidade do Porto) in May and June 2024, as part of the Nós Project, funded by the Ministerio para la Transformación Digital y de la Función Pública and co-financed by the European Union – NextGenerationEU, within the framework of the ILENIA Project (reference: 2022/TL22/00215336).
 
+The stay at the University of Porto (CODA-FLUP) was supported by the IACOBUS Programme (2024), a Galician–Portuguese initiative that facilitates, among other activities, research exchanges between Galician scholars and universities or technological centers in Northern Portugal, and vice versa. The programme is managed by the AECT Galicia–North of Portugal.