demo-chatbot-v3 / README.md
rodrisouza's picture
Update README.md
0392417 verified

Chatbot Demo V3

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."

Estructura del Proyecto

  • 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.
  • 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.
  • .gitattributes: Archivo de configuraci贸n para Git, utilizado para manejar archivos de texto y otros aspectos espec铆ficos del control de versiones.
  • requirements.txt: Lista de dependencias de Python necesarias para ejecutar el proyecto.
  • tokyo-portal-326513-90aee094bab9.json: Archivo de credenciales utilizado para la autenticaci贸n con Google Sheets.
  • user_guide.txt: Gu铆a de usuario para el chatbot, proporcionando instrucciones sobre c贸mo utilizar la aplicaci贸n.

Requisitos

  • Python 3.8+

  • Dependencias: Todas las dependencias necesarias est谩n listadas en el archivo requirements.txt. Puedes instalarlas ejecutando:

    pip install -r requirements.txt
    

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.

Uso

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.

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.

python app.py

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.

Evaluaci贸n: Despu茅s de la interacci贸n, puedes puntuar la conversaci贸n y dejar un comentario. Estos datos se guardar谩n tanto localmente como en Google Sheets.

Estructura del C贸digo

Carga de modelos: Los modelos de lenguaje se cargan din谩micamente basados en la selecci贸n del usuario. Interacci贸n: El chatbot maneja la conversaci贸n asegur谩ndose de que los roles de usuario y asistente alternen correctamente. Almacenamiento de datos: Las interacciones del usuario, junto con sus evaluaciones, se almacenan en una hoja de Google Sheets para su posterior an谩lisis. Personalizaci贸n Puedes personalizar la aplicaci贸n ajustando los modelos disponibles, los prompts del sistema, y las historias directamente en el archivo config.py o actualizando las hojas de Google Sheets asociadas.

Contribuciones

Si deseas contribuir a este proyecto, por favor sigue los siguientes pasos:

  1. Haz un fork del repositorio.
  2. Crea una nueva rama (git checkout -b feature-nueva-funcionalidad).
  3. Realiza tus cambios y haz commit (git commit -am 'A帽adir nueva funcionalidad').
  4. Env铆a tus cambios a tu repositorio (git push origin feature-nueva-funcionalidad).
  5. Abre un Pull Request.

Licencia

Este proyecto est谩 bajo la Licencia MIT.