rodrisouza commited on
Commit
1e1d89a
verified
1 Parent(s): 1222fb2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -19
README.md CHANGED
@@ -1,30 +1,30 @@
1
- Chatbot Demo V3
 
2
  Este proyecto es un prototipo de chatbot desarrollado con Gradio y Hugging Face, dise帽ado para experimentar con diferentes modelos de lenguaje para la ense帽anza del ingl茅s a adolescentes hispanohablantes. Este chatbot es parte de un proyecto m谩s amplio llamado "M茅todos de generaci贸n controlada para la construcci贸n de agentes conversacionales de apoyo a la ense帽anza de ingl茅s."
3
 
4
- Estructura del Proyecto
5
- app.py: Contiene la l贸gica principal del chatbot, incluida la carga del modelo, la interacci贸n con los usuarios y la integraci贸n con Google Sheets para el almacenamiento de datos.
6
- config.py: Archivo de configuraci贸n que maneja la autenticaci贸n con Google Sheets, la configuraci贸n de los modelos disponibles, y otros par谩metros clave del proyecto.
7
- .gitattributes: Archivo de configuraci贸n para Git, utilizado para manejar archivos de texto y otros aspectos espec铆ficos del control de versiones.
8
- requirements.txt: Lista de dependencias de Python necesarias para ejecutar el proyecto.
9
- tokyo-portal-326513-90aee094bab9.json: Archivo de credenciales utilizado para la autenticaci贸n con Google Sheets.
10
- user_guide.txt: Gu铆a de usuario para el chatbot, proporcionando instrucciones sobre c贸mo utilizar la aplicaci贸n.
11
- Requisitos
12
- Python 3.8+
13
-
14
- Dependencias: Todas las dependencias necesarias est谩n listadas en el archivo requirements.txt. Puedes instalarlas ejecutando:
15
-
16
- bash
17
- Copy code
18
- pip install -r requirements.txt
19
- Credenciales de Google Sheets: El archivo tokyo-portal-326513-90aee094bab9.json debe estar en el directorio ra铆z del proyecto para permitir la conexi贸n con Google Sheets.
20
 
 
 
 
 
 
 
 
21
  Uso
22
  Configuraci贸n: Aseg煤rate de que todas las dependencias est茅n instaladas y que el archivo config.py est茅 correctamente configurado con tus credenciales de Google Sheets y tu token de Hugging Face.
23
 
24
  Ejecuci贸n del Chatbot: Ejecuta el archivo app.py para iniciar la aplicaci贸n. Esto abrir谩 una interfaz de usuario basada en Gradio en tu navegador.
25
 
26
- bash
27
- Copy code
28
  python app.py
29
  Interacci贸n: Usa la interfaz para seleccionar un modelo, una historia, y un prompt del sistema. Luego, puedes interactuar con el chatbot a trav茅s de la caja de chat.
30
 
@@ -45,5 +45,6 @@ Crea una nueva rama (git checkout -b feature-nueva-funcionalidad).
45
  Realiza tus cambios y haz commit (git commit -am 'A帽adir nueva funcionalidad').
46
  Env铆a tus cambios a tu repositorio (git push origin feature-nueva-funcionalidad).
47
  Abre un Pull Request.
 
48
  Licencia
49
  Este proyecto est谩 bajo la Licencia MIT.
 
1
+ # Chatbot Demo V3
2
+
3
  Este proyecto es un prototipo de chatbot desarrollado con Gradio y Hugging Face, dise帽ado para experimentar con diferentes modelos de lenguaje para la ense帽anza del ingl茅s a adolescentes hispanohablantes. Este chatbot es parte de un proyecto m谩s amplio llamado "M茅todos de generaci贸n controlada para la construcci贸n de agentes conversacionales de apoyo a la ense帽anza de ingl茅s."
4
 
5
+ ## Estructura del Proyecto
6
+
7
+ - **`app.py`**: Contiene la l贸gica principal del chatbot, incluida la carga del modelo, la interacci贸n con los usuarios y la integraci贸n con Google Sheets para el almacenamiento de datos.
8
+ - **`config.py`**: Archivo de configuraci贸n que maneja la autenticaci贸n con Google Sheets, la configuraci贸n de los modelos disponibles, y otros par谩metros clave del proyecto.
9
+ - **`.gitattributes`**: Archivo de configuraci贸n para Git, utilizado para manejar archivos de texto y otros aspectos espec铆ficos del control de versiones.
10
+ - **`requirements.txt`**: Lista de dependencias de Python necesarias para ejecutar el proyecto.
11
+ - **`tokyo-portal-326513-90aee094bab9.json`**: Archivo de credenciales utilizado para la autenticaci贸n con Google Sheets.
12
+ - **`user_guide.txt`**: Gu铆a de usuario para el chatbot, proporcionando instrucciones sobre c贸mo utilizar la aplicaci贸n.
13
+
14
+ ## Requisitos
 
 
 
 
 
 
15
 
16
+ - **Python 3.8+**
17
+ - **Dependencias**: Todas las dependencias necesarias est谩n listadas en el archivo `requirements.txt`. Puedes instalarlas ejecutando:
18
+
19
+ ```bash
20
+ pip install -r requirements.txt
21
+
22
+ Credenciales de Google Sheets: El archivo tokyo-portal-326513-90aee094bab9.json debe estar en el directorio ra铆z del proyecto para permitir la conexi贸n con Google Sheets.
23
  Uso
24
  Configuraci贸n: Aseg煤rate de que todas las dependencias est茅n instaladas y que el archivo config.py est茅 correctamente configurado con tus credenciales de Google Sheets y tu token de Hugging Face.
25
 
26
  Ejecuci贸n del Chatbot: Ejecuta el archivo app.py para iniciar la aplicaci贸n. Esto abrir谩 una interfaz de usuario basada en Gradio en tu navegador.
27
 
 
 
28
  python app.py
29
  Interacci贸n: Usa la interfaz para seleccionar un modelo, una historia, y un prompt del sistema. Luego, puedes interactuar con el chatbot a trav茅s de la caja de chat.
30
 
 
45
  Realiza tus cambios y haz commit (git commit -am 'A帽adir nueva funcionalidad').
46
  Env铆a tus cambios a tu repositorio (git push origin feature-nueva-funcionalidad).
47
  Abre un Pull Request.
48
+
49
  Licencia
50
  Este proyecto est谩 bajo la Licencia MIT.