Retrieval Augmented Generation Intro Project

Proyecto de introducción de generación aumentada de recuperación (RAG)?

¡Bienvenido al proyecto de generación aumentada de recuperación (RAG)! ? Este proyecto tiene como objetivo introducir y demostrar las aplicaciones prácticas de RAG utilizando el código Python en un entorno de cuaderno Jupyter. El llameAindex se utiliza aquí. ¡Creemos que aprender y experimentar con trapo debería ser educativo y divertido! ?

Estructura de proyectos

El proyecto está organizado en varias carpetas:

• Archivos : esta carpeta contiene archivos importantes para su referencia:

  • readme.md : ¡Actualmente estás leyendo este archivo! Proporciona una descripción general del proyecto.
  • Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf : este archivo explica la información de fondo y proporciona información adicional de experimentos prácticos utilizando RAG. ¡Es una lectura obligada para comenzar!

• Python_env : en esta carpeta, encontrará el archivo NLP.yml . Importe este archivo YAML para crear un entorno Python dedicado para ejecutar el código sin problemas.

• Código : La carpeta de code contiene tres archivos de cuaderno Jupyter, cada uno que representa un experimento diferente:

  • 1_Basic_RAG_Pipeline.ipynb : este cuaderno demuestra la tubería de trapo básica. Es un gran punto de partida para comprender los fundamentos del trapo.
  • 2_Sentence_window_retrieval.ipynb : este cuaderno explora el concepto de recuperación de la ventana de oraciones usando trapo. Descubra cómo RAG puede recuperar información de una ventana de contexto específica.
  • 3_Auto-merging_Retrieval.ipynb : En este cuaderno, aprenderá sobre la recuperación automática y cómo mejora el proceso de generación. ¡Cosas emocionantes!

• Datos : La carpeta data es donde puede almacenar sus propios documentos de interés para la recuperación. Por ahora, hemos incluido un archivo de ejemplo llamado Henry.txt . Siéntase libre de reemplazarlo con sus propios documentos para experimentar con RAG.

• Común : dentro de esta carpeta, encontrará el archivo openAI.env . No olvide agregar su tecla API de OpenAI en este archivo para habilitar la interacción perfecta con los modelos OpenAI.

Empezando

Para comenzar su viaje de trapos, siga estos pasos:

1. Clon o descargue este repositorio de proyecto a su máquina local.

2. Importe el archivo NLP.yml en la carpeta python_env para crear un entorno python dedicado. Esto asegura que todas las dependencias estén instaladas correctamente.

3. En la carpeta common , abra el archivo openAI.env e ingrese su tecla API OpenAI. Este paso es crucial para acceder a los modelos OpenAI.

4. Familiarícese con el proyecto leyendo la Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf en la carpeta files . Proporciona información de fondo importante y experimentos prácticos.

5. Explore los tres archivos de cuaderno Jupyter ( 1_Basic_RAG_Pipeline.ipynb , 2_Sentence_window_retrieval.ipynb y 3_Auto-merging_Retrieval.ipynb ) en la carpeta code . ¡Ejecute los cuadernos para ver el trapo en acción!

6. Experimente con RAG modificando los ejemplos proporcionados o utilizando sus propios documentos en la carpeta data . ¡Siéntase libre de ser creativo y divertirse con eso! ?

Conclusión ?

¡Felicidades! Ahora está equipado con la información y las herramientas necesarias para aprender, aplicar y divertirse con la generación de recuperación aumentada (RAG). Esperamos que este proyecto despierta su curiosidad y lo aliente a explorar el emocionante mundo del trapo utilizando los cuadernos Jupyter proporcionados. ¡Feliz generación! ?

Si tiene alguna pregunta o necesita más ayuda, no dude en comunicarse. ¡Disfruta tu viaje de trapo! ?