L1-LlamaIndex RAG 实践

任务链接：Tutorial/docs/L1/LlamaIndex/task.md at camp3 · InternLM/Tutorial · GitHub

1. 基础任务

基于 LlamaIndex 构建自己的 RAG 知识库，寻找一个问题 A 在使用 LlamaIndex 之前InternLM2-Chat-1.8B模型不会回答，借助 LlamaIndex 后 InternLM2-Chat-1.8B 模型具备回答 A 的能力。

# 环境配置略
# 仍然使用之前创建的lmdeploy环境
conda activate lmdeploy
pip install llama-index==0.10.38 llama-index-llms-huggingface==0.2.0 "transformers[torch]==4.41.1" "huggingface_hub[inference]==0.23.1" huggingface_hub==0.23.1 sentence-transformers==2.7.0 sentencepiece==0.2.0


# 创建所需目录和文件
cd ~
# 用于运行代码
mkdir llamaindex_demo
# 用于保存模型
mkdir model
cd ~/llamaindex_demo
touch download_hf.py

1.1 下载 Sentence Transformer 模型

使用开源词向量模型 Sentence Transformer 来进行 Embedding，它相对轻量、支持中文且效果较好。

在download_hf.py中写入

import os

# 设置环境变量
os.environ['HF_ENDPOINT'] = 'https://hf-mirror.com'

# 下载模型
os.system('huggingface-cli download --resume-download sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2 --local-dir /root/model/sentence-transformer')

# 下载模型
cd /root/llamaindex_demo
python download_hf.py

1.2 下载 NLTK 相关资源

我们在使用开源词向量模型构建开源词向量的时候，需要用到第三方库 nltk 的一些资源。正常情况下，其会自动从互联网上下载，但可能由于网络原因会导致下载中断，此处我们可以从国内仓库镜像地址下载相关资源，保存到服务器上。 我们用以下命令下载 nltk 资源并解压到服务器上：

cd /root
git clone https://gitee.com/yzy0612/nltk_data.git  --branch gh-pages
cd nltk_data
mv packages/*  ./
cd tokenizers
unzip punkt.zip
cd ../taggers
unzip averaged_perceptron_tagger.zip

1.3 实验

1.3.1 不使用RAG

# 拷贝模型 InternLM2 1.8B
cd ~/model
ln -s /root/share/new_models/Shanghai_AI_Laboratory/internlm2-chat-1_8b/ ./

# 创建不使用RAG的文件
cd ~/llamaindex_demo
touch llamaindex_internlm.py

 在 llamaindex_internlm.py 中写入

from llama_index.llms.huggingface import HuggingFaceLLM
from llama_index.core.llms import ChatMessage

llm = HuggingFaceLLM(
    model_name="/root/model/internlm2-chat-1_8b",
    tokenizer_name="/root/model/internlm2-chat-1_8b",
    model_kwargs={"trust_remote_code":True},
    tokenizer_kwargs={"trust_remote_code":True}
)

rsp = llm.chat(messages=[ChatMessage(content="xtuner是什么？")])
print(rsp)

运行代码 

python llamaindex_internlm.py

结果表明模型并不认识xtuner 

1.3.2 LlamaIndex RAG

安装 LlamaIndex 词嵌入向量依赖

# 安装LlamaIndex
pip install llama-index-embeddings-huggingface llama-index-embeddings-instructor

# 获取知识库
cd ~/llamaindex_demo
# data用于存放知识库
mkdir data
cd data
git clone https://github.com/InternLM/xtuner.git
# 这里使用的是xtuner的readme文件
mv xtuner/README_zh-CN.md ./
# 用于实现RAG
touch llamaindex_RAG.py

 在 llamaindex_RAG.py 中写入

from llama_index.core import VectorStoreIndex, SimpleDirectoryReader, Settings
from llama_index.embeddings.huggingface import HuggingFaceEmbedding
from llama_index.llms.huggingface import HuggingFaceLLM

#初始化一个HuggingFaceEmbedding对象，用于将文本转换为向量表示
embed_model = HuggingFaceEmbedding(
#指定了一个预训练的sentence-transformer模型的路径
    model_name="/root/model/sentence-transformer"
)
#将创建的嵌入模型赋值给全局设置的embed_model属性，
#这样在后续的索引构建过程中就会使用这个模型。
Settings.embed_model = embed_model

llm = HuggingFaceLLM(
    model_name="/root/model/internlm2-chat-1_8b",
    tokenizer_name="/root/model/internlm2-chat-1_8b",
    model_kwargs={"trust_remote_code":True},
    tokenizer_kwargs={"trust_remote_code":True}
)
#设置全局的llm属性，这样在索引查询时会使用这个模型。
Settings.llm = llm

#从指定目录读取所有文档，并加载数据到内存中
documents = SimpleDirectoryReader("/root/llamaindex_demo/data").load_data()
#创建一个VectorStoreIndex，并使用之前加载的文档来构建索引。
# 此索引将文档转换为向量，并存储这些向量以便于快速检索。
index = VectorStoreIndex.from_documents(documents)
# 创建一个查询引擎，这个引擎可以接收查询并返回相关文档的响应。
query_engine = index.as_query_engine()
response = query_engine.query("xtuner是什么?")

print(response)

运行代码

python llamaindex_RAG.py