
<div align="justify">
  
**English text [here](https://huggingface.co/proxectonos/Nos_D2T-gl/edit/main/README_EN.md)**

**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/)
+ Para xerar un texto a partir dalgúns dos 568 casos de test do noso dataset, empregarase o seguinte comando:
```bash
python generate_text.py -i <data_id> -o <output_path>
```
+ O argumento **-i** indica o ID da táboa de datos da cal se quere xerar un texto. Serán validos IDs de 0 ata 569, xa que estos son os casos de test dispoñibles cos que non se adestrou o modelo.
+ O argumento **-o** empregase para indicar o path no cal se creará un arquivo co texto xerado. En caso de non indicarse crearase o arquivo no directorio actual.

**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. O dataset componse de 3,302 rexistros de datos tabulares de prediccións meteorolóxicas reais xunto con descripcións textuais feitas por expertos en galego.
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="https://huggingface.co/proxectonos/Nos_D2T-gl/resolve/main/exemplo-linearizacion.png" width="75%" style="margin:auto;">

Desta forma, o modelo text-to-text é quen de interpretar as táboas de datos "linearizadas" e os seus textos asociados, e así aprender a xerar textos que describan os datos estruturados que se lle proporcionen como input.

Para realizar o fine-tuning sobre o modelo empregaronse os seguintes hiperparámetros:
+ Batch size: 8
+ Optimizer: Adam
+ Learning rate: 1e-5
+ Training epochs: 1000

**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 convenio entre a Xunta de Galicia e a Universidade de Santiago de Compostela, e polas axudas ED431G2019/04 e ED431C2022/19 da Consellaría de Educación, Universidade e Formación Profesional e polo Fondo Europeo de Desenvolvemento Rexional (programa ERDF/FEDER).
 
</div>

**Citar este traballo**

Se utiliza 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/




{"language": ["gl"], "license": "mit"}
gl license:mit region:us
TAGS
#gl #license-mit #region-us 


<div align="justify">
  
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 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
+ Para xerar un texto a partir dalgúns dos 568 casos de test do noso dataset, empregarase o seguinte comando:

+ O argumento -i indica o ID da táboa de datos da cal se quere xerar un texto. Serán validos IDs de 0 ata 569, xa que estos son os casos de test dispoñibles cos que non se adestrou o modelo.
+ O argumento -o empregase para indicar o path no cal se creará un arquivo co texto xerado. En caso de non indicarse crearase o arquivo no directorio actual.

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: URL O dataset componse de 3,302 rexistros de datos tabulares de prediccións meteorolóxicas reais xunto con descripcións textuais feitas por expertos en galego.
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="URL width="75%" style="margin:auto;">

Desta forma, o modelo text-to-text é quen de interpretar as táboas de datos "linearizadas" e os seus textos asociados, e así aprender a xerar textos que describan os datos estruturados que se lle proporcionen como input.

Para realizar o fine-tuning sobre o modelo empregaronse os seguintes hiperparámetros:
+ Batch size: 8
+ Optimizer: Adam
+ Learning rate: 1e-5
+ Training epochs: 1000

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 convenio entre a Xunta de Galicia e a Universidade de Santiago de Compostela, e polas axudas ED431G2019/04 e ED431C2022/19 da Consellaría de Educación, Universidade e Formación Profesional e polo Fondo Europeo de Desenvolvemento Rexional (programa ERDF/FEDER).
 
</div>

Citar este traballo

Se utiliza este modelo no seu traballo, cite por favor así:

González Corbelle, Javier; Bugarín Diz, Alberto. 2023 Nos_D2T-gl. URL: URL




TAGS
#gl #license-mit #region-us 

TAGS
#gl #license-mit #region-us 
