Retrieval Augmented Generation Intro Project

Projet intro de la génération augmentée de récupération (RAG) ??

Bienvenue dans le projet de génération augmentée (RAG) de récupération! ? Ce projet vise à introduire et à démontrer les applications pratiques de RAG en utilisant le code Python dans un environnement de cahier de jupyter. Le Llamaindex est utilisé ici. Nous pensons que l'apprentissage et l'expérimentation de RAG devraient être à la fois éducatifs et amusants! ?

Structure du projet

Le projet est organisé en plusieurs dossiers:

• Fichiers : ce dossier contient des fichiers importants pour votre référence:

  • readme.md : vous lisez actuellement ce fichier! Il donne un aperçu du projet.
  • Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf : Ce fichier explique les informations générales et fournit des informations supplémentaires sur des expériences pratiques à l'aide de RAG. C'est une lecture incontournable pour commencer!

• Python_env : Dans ce dossier, vous trouverez le fichier NLP.yml . Importez ce fichier YAML pour créer un environnement Python dédié pour exécuter le code de manière transparente.

• Code : Le dossier code contient trois fichiers de cahier Jupyter, chacun représentant une expérience différente:

  • 1_Basic_RAG_Pipeline.ipynb : Ce cahier démontre le pipeline de chiffon de base. C'est un excellent point de départ pour comprendre les principes fondamentaux du chiffon.
  • 2_Sentence_window_retrieval.ipynb : Ce cahier explore le concept de récupération de la fenêtre de phrase à l'aide de RAG. Découvrez comment RAG peut récupérer des informations à partir d'une fenêtre de contexte spécifique.
  • 3_Auto-merging_Retrieval.ipynb Des trucs passionnants!

• Données : Le dossier data est l'endroit où vous pouvez stocker vos propres documents d'intérêt pour la récupération. Pour l'instant, nous avons inclus un exemple de fichier nommé Henry.txt . N'hésitez pas à le remplacer par vos propres documents pour expérimenter avec RAG.

• Common : à l'intérieur de ce dossier, vous trouverez le fichier openAI.env . N'oubliez pas d'ajouter votre touche API OpenAI dans ce fichier pour permettre une interaction transparente avec les modèles OpenAI.

Commencer

Pour commencer votre voyage de chiffon, suivez ces étapes:

1. Clone ou téléchargez ce référentiel de projet sur votre machine locale.

2. Importez le fichier NLP.yml dans le dossier python_env pour créer un environnement Python dédié. Cela garantit que toutes les dépendances sont correctement installées.

3. Dans le dossier common , ouvrez le fichier openAI.env et entrez votre touche API OpenAI. Cette étape est cruciale pour accéder aux modèles OpenAI.

4. Familiarisez-vous avec le projet en lisant l' Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf dans le dossier files . Il fournit des informations générales importantes et des expériences pratiques.

5. Explorez les trois fichiers de cahier Jupyter ( 1_Basic_RAG_Pipeline.ipynb , 2_Sentence_window_retrieval.ipynb et 3_Auto-merging_Retrieval.ipynb ) dans le dossier code . Exécutez les cahiers pour voir Rag en action!

6. Expérimentez avec RAG en modifiant les exemples fournis ou en utilisant vos propres documents dans le dossier data . N'hésitez pas à faire preuve de créativité et à vous amuser avec! ?

Conclusion ?

Félicitations! Vous êtes maintenant équipé des informations et des outils nécessaires pour apprendre, appliquer et vous amuser avec la génération augmentée de récupération (RAG). Nous espérons que ce projet déclenche votre curiosité et vous encourage à explorer le monde passionnant du chiffon en utilisant les cahiers de jupyter fournis. Bonne génération! ?

Si vous avez des questions ou avez besoin d'aide supplémentaire, n'hésitez pas à tendre la main. Profitez de votre voyage de chiffon! ?