Update README.md

README.md

@@ -1,3 +1,79 @@
 ---
 license: mit
----
+language:
+- gl
+---
+
+
+<!--**English text [here]()**-->
+
+**Descrición do Modelo**
+Fine-tuning dun modelo text-to-text para realizar a tarefa de data-to-text en galego. Partindo do modelo [MT5-base](https://huggingface.co/google/mt5-base) multilingüe pre-adestrado para tarefas text-to-text, aplicase a técnica de fine-tuning para conseguir un modelo que realice a tarefa de xeración data-to-text en galego.
+
+**Como xerar textos a partir de táboas de datos**
+
++ Abrir terminal bash
++ Instalar [Python 3.10](https://www.python.org/downloads/release/python-3104/)
++ Xerar textos a partir de táboas de datos co seguinte comando:  
+```bash
+python generate_text.py -i <datat_id> -o <output_path>
+```
+
+ 
+**Adestramento**
+Para adestrar o modelo na tarefa data-to-text empregouse o primeiro dataset público para data-to-text en galego liberado polo Proxecto Nós e que se atopa dispoñíbel no seguinte repositorio: https://zenodo.org/record/7661650#.ZA8aZ3bMJro
+Debido a que o modelo base usa como entrada un formato textual e os nosos datos de entrada son en formato táboa, realizamos un proceso de linearización sobre os datos estruturados. Este proceso consiste en transformar as táboas de datos en datos textuais etiquetados da seguinte maneira:
+
+<img src="">
+
+ 
+<!--**Procedemento de adestramento**
++ Pre-procesado dos datos (linearization)
++ Script de adestramento
++ ```bash 
+codigo para adestrar o modelo
+```
+**Hiperparámetros** 
+Os parámetros usados para o adestramento do modelo son os configurados no script de adestramento.
+Engadir datos dos hiperparámetros por defecto
+
+
+**Avaliación**
+-->
+**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í:
+
+González Corbelle, Javier; Bugarín Diz, Alberto. 2023 Nos_D2T-gl. URL: https://huggingface.co/proxectonos/Nos_D2T-gl/
+
+
+