Retrieval Augmented Generation Intro Project

检索增强发电（RAG）介绍项目？

欢迎来到检索增强一代（RAG）项目！ ？该项目旨在在Jupyter笔记本电脑环境中使用Python代码介绍和演示RAG的实际应用。 LlamainDex在这里使用。我们认为，学习和实验抹布应该是教育和乐趣！ ？

项目结构

该项目分为几个文件夹：

• 文件：此文件夹包含您的参考的重要文件：

  • readme.md ：您当前正在阅读此文件！它提供了该项目的概述。
  • Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf ：此文件解释了背景信息，并提供了使用抹布的动手实验的其他信息。这是开始的必读！

• python_env ：在此文件夹中，您会找到NLP.yml文件。导入此YAML文件以创建专用的Python环境，以无缝运行代码。

• 代码： code文件夹包含三个jupyter笔记本文件，每个文件代表一个不同的实验：

  • 1_Basic_RAG_Pipeline.ipynb ：此笔记本演示了基本的抹布管道。这是理解抹布的基本原理的好起点。
  • 2_Sentence_window_retrieval.ipynb ：此笔记本探索使用抹布的句子窗口检索的概念。发现破布如何从特定上下文窗口中检索信息。
  • 3_Auto-merging_Retrieval.ipynb ：在此笔记本中，您将了解自动合并检索以及它如何改善生成过程。令人兴奋的东西！

• 数据： data文件夹是您可以存储自己感兴趣的文档以进行检索的地方。目前，我们提供了一个名为Henry.txt的示例文件。随时用自己的文档替换它，以尝试用抹布进行实验。

• 常见：在此文件夹中，您会找到openAI.env文件。不要忘记在此文件中添加OpenAI API键，以启用与OpenAI型号的无缝交互。

入门

要开始您的破布旅程，请按照以下步骤：

1. 克隆或将此项目存储库下载到您的本地计算机。

2. 在python_env文件夹中导入NLP.yml文件以创建专用的Python环境。这样可以确保正确安装所有依赖项。

3. 在common文件夹”中，打开openAI.env文件并输入您的OpenAI API键。此步骤对于访问OpenAI模型至关重要。

4. 通过阅读files文件夹中Intro of Retrieval Augmented Generation (RAG) and application demos_Henry.pdf来熟悉该项目。它提供了重要的背景信息和动手实验。

5. 探索三个jupyter笔记本文件（ 1_Basic_RAG_Pipeline.ipynb ， 2_Sentence_window_retrieval.ipynb和3_Auto-merging_Retrieval.ipynb ）在code文件夹中。运行笔记本以查看抹布的行动！

6. 通过修改提供的示例或在data文件夹中使用自己的文档来实验抹布。随时发挥创造力，并为之带来乐趣！ ？

结论 ？

恭喜！现在，您配备了学习，申请和娱乐的必要信息和工具，并通过检索增强发电（RAG）获得乐趣。我们希望这个项目能够激发您的好奇心，并鼓励您使用提供的Jupyter笔记本探索激动人心的抹布世界。生成快乐！ ？

如果您有任何疑问或需要进一步的帮助，请随时伸出援手。享受您的破布旅程！ ？