Update README.md (#3)

- Update README.md (f655a1f1520ff23c6541d72269e0ea7ab3a4698b)


Co-authored-by: Oscar Alberto <iXrst@users.noreply.huggingface.co>

README.md

@@ -14,7 +14,13 @@ tags:
 - recetas
 - cocina
 ---
-# Nombre del Corpus
+# Motivación inicial
+
+<!-- Motivation for the creation of this dataset. -->
+Este corpus ha sido creado durante el Hackathon SomosNLP Marzo 2024: #Somos600M (https://somosnlp.org/hackathon).
+Responde a una de las propuestas somosnlp sobre 'Recetas típicas por país/zona geográfica'.
+
+# Nombre del Proyecto
 
 <!-- Provide a quick summary of the dataset. -->
 Este corpus o dataset se llama 'RecetasDeLaAbuel@' y es un homenaje a todas nuestr@s abuel@s que nos han enseñado a cocinar. Se trata de la mayor y más completa colección de recetas open-source en español de países hispanoamericanos.
@@ -25,7 +31,10 @@ Este corpus o dataset se llama 'RecetasDeLaAbuel@' y es un homenaje a todas nues
 </p>
 
 
-### Descripción del Corpus
+
+
+## Corpus
+## Descripción
 
 <!-- Provide a longer summary of what this dataset is. -->
 Este corpus contiene los principales elementos de una receta de cocina (título, descripción, ingredientes y preparación). Se ha completado con otros 11 atributos 
@@ -35,44 +44,8 @@ hasta completar un impresionante dataset con más de 300k (20k x 15) items.
 - **Funded by:** rovi27, sbenel, GaboTuco, iXrst
 - **Language(s) (NLP):** Python
 - **License:** openrail
-
-### Origen del Corpus
-
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** https://huggingface.co/datasets/somosnlp/RecetasDeLaAbuela
-- **Paper:** TBW
-- **Corpus de Instrucciones Original:** https://huggingface.co/datasets/somosnlp/recetasdelaabuela_genstruct_it
-- **Corpus de Instrucciones Curado:** https://huggingface.co/datasets/somosnlp/recetasdelaabuela_it
-  
-- **Modelo LLM RecetasDeLaAbuel@:** https://huggingface.co/somosnlp/RecetasDeLaAbuela_gemma-2b-it-bnb-4bit
-- **Demo RecetasDeLaAbuel@:** https://huggingface.co/spaces/somosnlp/RecetasDeLaAbuela_Demo
-  
-- **Modelo LLM ComeBien:** https://huggingface.co/somosnlp/ComeBien_gemma-2b-it-bnb-4bit
-- **Demo ComeBien:** https://huggingface.co/spaces/somosnlp/ComeBien_Demo
-
-## Política de Uso
-
-<!-- Address questions around how the dataset is intended to be used. -->
-
-### Uso directo
-
-<!-- This section describes suitable use cases for the dataset. -->
-Nuestra Misión es la creación del mejor asistente de cocina inteligente específico del idioma español (corpus Recetas de la Abuel@) que agrupe recetas de países hispanoamericanos 
-y permita mejorar nuestra relación con la preparación y el cocinado de los alimentos.
-
-Nuestra IA responderá a cuestiones de los sigientes tipos:
-'Dime la receta del ceviche, frijoles, tortilla de patata, paella, etc'
-'Qué puedo cocinar con 3 ingredientes?', 
-'Dime una comida de temporada para este mes de Marzo?' , 
-'Propón un menú mensual para una familia'
-
-### Fuera de alcance
-
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-Queda excluido cualquier uso no contemplado por la UE AI Policity (https://www.consilium.europa.eu/es/policies/artificial-intelligence/)
-
-## Estructura del Corpus
+- 
+### Estructura
 
 <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
 Este dataset 'RecetasDeLaAbuel@' tiene formato tabular (20k x 15). Cada fila de datos tiene los siguieentes atributos:
@@ -80,8 +53,8 @@ Este dataset 'RecetasDeLaAbuel@' tiene formato tabular (20k x 15). Cada fila de
 - URL
 - Ingredientes
 - Pasos 
-- Pais 
-- Duracion 
+- País (ISO_A3)
+- Duracion (HH:MM)
 - Porciones 
 - Calorias 
 - Categoria 
@@ -93,45 +66,72 @@ Este dataset 'RecetasDeLaAbuel@' tiene formato tabular (20k x 15). Cada fila de
 - Valor nutricional
 - Tematica (en curso)
 
-## Creación del Corpus
+### Fuentes de datos
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+La información básica se ha recolectado y procesado mediante las técnicas conocidas como 'web scrapping'.
+La información original se encuentra ubicada en las siguientes páginas web:
+- recetasgratis.net
+- elmueble.com
+- yanuq.com
+- directoalpaladar.com
+- cookpad.com/pe
+- mexicoenmicocina.com
+
+Para más información sobre recetas de cocina dirijanse a dichas páginas web. Expresamos nuestro reconocimiento y agradecimiento a sus autores.
 
-## Estadísticas del Corpus
+### Procesamiento de datos
 
-### Motivación inicial
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+Se utilizó scripts de Python para hacer el procesamiento del corpus, y las funciones de limpieza y curación del dataset.
+** https://huggingface.co/datasets/somosnlp/RecetasDeLaAbuela/blob/main/stats.pdf
 
-<!-- Motivation for the creation of this dataset. -->
-Este corpus ha sido creado durante el Hackathon SomosNLP Marzo 2024: #Somos600M (https://somosnlp.org/hackathon).
-Responde a una de las propuestas somosnlp sobre 'Recetas típicas por país/zona geográfica'.
+### Estadísticas
 
-### Fuentes de datos
+Son 20447 registros de recetas.
+** https://huggingface.co/datasets/somosnlp/RecetasDeLaAbuela/blob/main/stats.pdf
 
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-La información de las recetas de cocina se ha extraído de los principales sitios webs de recetas de cocina en español.
+## Política de Uso
 
-#### Recolección y procesamiento de datos
+<!-- Address questions around how the dataset is intended to be used. -->
 
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-La información básica se ha recolectado y procesado mediante las técnicas conocidas como 'web scrapping'.
+### Uso directo
+
+<!-- This section describes suitable use cases for the dataset. -->
+Nuestra Misión es la creación del mejor asistente de cocina inteligente específico del idioma español (corpus Recetas de la Abuel@) que agrupe recetas de países hispanoamericanos 
+y permita mejorar nuestra relación con la preparación y el cocinado de los alimentos.
+
+Nuestra IA responderá a cuestiones de los sigientes tipos:
+'Dime la receta del ceviche, frijoles, tortilla de patata, paella, etc'
+'Qué puedo cocinar con 3 ingredientes?', 
+'Dime una comida de temporada para este mes de Marzo?' , 
+'Propón un menú mensual para una familia'
 
-#### Entrenamiento del modelo LLM
+### Fuera de alcance
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+Queda excluido cualquier uso no contemplado por la UE AI Policity (https://www.consilium.europa.eu/es/policies/artificial-intelligence/)
+
+## Entrenamiento del modelo LLM
 
 Consultese el informe adjunto wandb: 
 https://huggingface.co/datasets/somosnlp/RecetasDeLaAbuela/blob/main/RecetasDeLaAbuel%40%20Report%20_%20Recetas19kTest20_gemma-2b-it-bnb-4bit%20%E2%80%93%20Weights%20%26%20Biases.pdf
 
-#### Generación de la información
+# Links del proyecto
 
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-La información original se encuentra ubicada en las siguientes páginas web:
-- recetasgratis.net
-- elmueble.com
-- yanuq.com
-- directoalpaladar.com
-- cookpad.com/pe
-- mexicoenmicocina.com
+<!-- Provide the basic links for the dataset. -->
 
-Para más información sobre recetas de cocina dirijanse a dichas páginas web. Expresamos nuestro reconocimiento y agradecimiento a sus autores.
+- **Repository:** https://huggingface.co/datasets/somosnlp/RecetasDeLaAbuela
+- **Paper:** TBW
+- **Corpus de Instrucciones Original:** https://huggingface.co/datasets/somosnlp/recetasdelaabuela_genstruct_it
+- **Corpus de Instrucciones Curado:** https://huggingface.co/datasets/somosnlp/recetasdelaabuela_it
+  
+- **Modelo LLM RecetasDeLaAbuel@:** https://huggingface.co/somosnlp/RecetasDeLaAbuela_gemma-2b-it-bnb-4bit
+- **Demo RecetasDeLaAbuel@:** https://huggingface.co/spaces/somosnlp/RecetasDeLaAbuela_Demo
+  
+- **Modelo LLM ComeBien:** https://huggingface.co/somosnlp/ComeBien_gemma-2b-it-bnb-4bit
+- **Demo ComeBien:** https://huggingface.co/spaces/somosnlp/ComeBien_Demo
 
-## Citaciones
+# Citaciones
 
 <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
 Este trabajo se ha basado y es continuación del trabajo desarrollado en el siguiente corpus durante el Hackhaton somosnlp 2023:
@@ -149,7 +149,7 @@ Asismismo debemos reconocer y agradecer la labor de Tiago en la recopilación de
 - 50 recetas Fáciles, Sanas, Rápidas y Económicas - Antojo en tu cocina
 - 54 recetas saludables para niños, comidas sanas y fáciles de hacer
 
-## Autores
+# Autores
 
 https://huggingface.co/rovi27 <br>
 https://huggingface.co/sbenel <br>
@@ -157,11 +157,11 @@ https://huggingface.co/GabTuco <br>
 https://huggingface.co/iXrst <br>
 
 
-## Asesoría Académica 
+# Asesoría Académica 
 
 Modelización de temática mediante BERTopic
 https://huggingface.co/andreamorgar
 
 
-## Contacto
+# Contacto
 mailto: recetasdelaabuela.comebien@gmail.com