1. 前置知识
正式介绍检索增强生成(Retrieval Augmented Generation,RAG)技术以前,大家不妨想想为什么会出现这样一个技术。 给模型注入新知识的方式,可以简单分为两种方式,一种是内部的,即更新模型的权重,另一个就是外部的方式,给模型注入格外的上下文或者说外部信息,不改变它的的权重。 第一种方式,改变了模型的权重即进行模型训练,这是一件代价比较大的事情,大语言模型具体的训练过程,可以参考InternLM2技术报告。 第二种方式,并不改变模型的权重,只是给模型引入格外的信息。类比人类编程的过程,第一种方式相当于你记住了某个函数的用法,第二种方式相当于你阅读函数文档然后短暂的记住了某个函数的用法。
对比两种注入知识方式,第二种更容易实现。RAG 正是这种方式。它能够让基础模型实现非参数知识更新,无需训练就可以掌握新领域的知识。本次课程选用了 LlamaIndex 框架。LlamaIndex 是一个上下文增强的 LLM 框架,旨在通过将其与特定上下文数据集集成,增强大型语言模型(LLMs)的能力。它允许您构建应用程序,既利用 LLMs 的优势,又融入您的私有或领域特定信息。
RAG 效果比对
如图所示,由于xtuner
是一款比较新的框架, InternLM2-Chat-1.8B
训练数据库中并没有收录到它的相关信息。左图中问答均未给出准确的答案。右图未对 InternLM2-Chat-1.8B
进行任何增训的情况下,通过 RAG 技术实现的新增知识问答。
2. 浦语 API+LlamaIndex 实践
2. 环境、模型准备
我直接用的开发机的SSH,你们用开发机也可以。
进入开发机后,创建新的conda环境,命名为 llamaindex
,在命令行模式下运行:
conda create -n llamaindex python=3.10
复制完成后,在本地查看环境。
conda env list
结果如下所示。
# conda environments: # base * /root/.conda llamaindex /root/.conda/envs/llamaindex
运行 conda
命令,激活 llamaindex
然后安装相关基础依赖 python 虚拟环境:
conda activate llamaindex
安装python 依赖包
pip install einops==0.7.0 protobuf==5.26.1
Einops
- 版本: 0.7.0
- 用途:
einops
是一个用于张量操作的库,旨在使代码更加清晰和简洁。它支持多种深度学习框架,如 PyTorch、TensorFlow、JAX 等。einops
提供了一种一致的方式来处理复杂的张量操作(例如重塑、转置、缩减等),使得代码更易于理解和维护。 - 特点:
- 简化复杂操作: 使用人类可读的方式表达张量的重塑、转置和缩减操作。
- 框架无关: 可以与多个深度学习框架一起使用,提供统一的操作接口。
- 提高代码可读性: 通过其独特的语法,可以显著提高代码的可读性和维护性。
例如,在处理多维数组时,einops
可以让你用一种直观的方式重排数据维度,而不需要记住复杂的索引或形状变换规则。
Protobuf (Protocol Buffers)
- 版本: 5.26.1
- 用途:
protobuf
是 Google 开发的一种语言中立、平台中立、可扩展的机制,用于序列化结构化数据。它允许你定义数据结构(称为“消息类型”)在一个.proto
文件中,然后使用protoc
编译器生成用于读写这些结构的源代码(如 C++, Java, Python 等语言)。这对于网络通信、数据存储和跨平台数据交换非常有用。 - 特点:
- 高效的数据编码格式: 相比于 XML 和 JSON,Protobuf 提供了更高效的二进制格式进行数据编码。
- 向前兼容性: 支持向后兼容的数据格式变更,这意味着你可以更新你的数据结构而不必担心破坏现有的数据或客户端代码。
- 跨语言支持: 支持多种编程语言,便于在不同平台和系统之间共享数据。
在安装指定版本的 protobuf
后,你可以使用它来定义你的数据结构,并利用生成的类轻松地在不同的应用组件之间传递信息。
总结
- Einops 主要用于简化和优化深度学习中的张量操作,使得代码更加易读和高效。
- Protobuf 则是一个强大的序列化工具,适合需要高效、可靠地传输和存储结构化数据的应用场景。
环境激活后,命令行左边会显示当前(也就是 llamaindex
)的环境名称,如下图所示:
2.2 安装 Llamaindex
安装 Llamaindex和相关的包
conda activate llamaindex pip install llama-index==0.11.20 pip install llama-index-llms-replicate==0.3.0 pip install llama-index-llms-openai-like==0.2.0 pip install llama-index-embeddings-huggingface==0.3.1 pip install llama-index-embeddings-instructor==0.2.1 pip install torch==2.5.0 torchvision==0.20.0 torchaudio==2.5.0 --index-url https://download.pytorch.org/whl/cu121
#注意:这块下载的时候有点慢 不过不要着急 pip list确保下载完成,不然后面后报错
2.3 下载 Sentence Transformer 模型
源词向量模型 Sentence Transformer:(我们也可以选用别的开源词向量模型来进行 Embedding,目前选用这个模型是相对轻量、支持中文且效果较好的,同学们可以自由尝试别的开源词向量模型) 运行以下指令,新建一个python文件
cd ~ mkdir llamaindex_demo mkdir model cd ~/llamaindex_demo touch download_hf.py
打开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')
然后,在 /root/llamaindex_demo 目录下执行该脚本即可自动开始下载:
cd /root/llamaindex_demo conda activate llamaindex python download_hf.py
更多关于镜像使用可以移步至 HF Mirror 查看。
推荐用户从modelscope下载
git lfs install
cd /root/model/
git clone https://www.modelscope.cn/Ceceliachenen/paraphrase-multilingual-MiniLM-L12-v2.git
mv paraphrase-multilingual-MiniLM-L12-v2 sentence-transformer
-
git lfs install
:- 这个命令初始化了Git Large File Storage (LFS) 客户端,使得你可以使用Git LFS来管理大型文件。Git LFS替代了大文件的内容(如图像、视频、数据集等)与文本指针,并将实际的大文件存储在GitHub或其他支持LFS的服务器上,而不是直接存储在Git仓库中。这有助于保持Git仓库的大小合理。
-
cd /root/model/
:- 该命令将当前工作目录更改为
/root/model/
。这意味着后续的所有操作都将在这个目录下执行。确保这个路径存在并且你有权限访问它。
- 该命令将当前工作目录更改为
-
git clone https://www.modelscope.cn/Ceceliachenen/paraphrase-multilingual-MiniLM-L12-v2.git
:- 使用
git clone
命令从指定的URL克隆一个Git仓库到本地机器。在这个例子中,是从https://www.modelscope.cn/Ceceliachenen/paraphrase-multilingual-MiniLM-L12-v2.git
克隆仓库。克隆完成后,会在当前目录下创建一个名为paraphrase-multilingual-MiniLM-L12-v2
的新文件夹,其中包含所有从远程仓库复制过来的文件。
- 使用
-
mv paraphrase-multilingual-MiniLM-L12-v2 sentence-transformer
:mv
命令用于移动文件或目录,也可以用来重命名它们。这里的用法是将刚刚克隆下来的paraphrase-multilingual-MiniLM-L12-v2
目录重命名为sentence-transformer
。这样做可能是为了简化名称或者适应项目的特定命名约定。
2.4 下载 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
-
git clone https://gitee.com/yzy0612/nltk_data.git --branch gh-pages
:此命令从指定的Gitee(一个类似于GitHub的中国代码托管平台)仓库克隆一个名为nltk_data
的项目到本地。特别地,它检出的是gh-pages
分支,这通常用于存放项目的网页内容或文档。 -
cd nltk_data
:进入通过上面的git clone
命令下载的nltk_data
目录。 -
mv packages/* ./
:这个命令将packages
目录下的所有文件移动到当前目录(即nltk_data
目录)。这里的./
代表当前目录。 -
接下来的两条命令:
cd tokenizers
unzip punkt.zip
这两行首先切换到
tokenizers
目录,然后解压位于该目录下的punkt.zip
文件。Punkt是NLTK(Natural Language Toolkit,自然语言工具包)中的一个句子分割器,用于识别文本中的句子边界。 -
最后两条命令:
cd ../taggers
unzip averaged_perceptron_tagger.zip
这些命令首先返回上一级目录(使用
../
),然后进入taggers
目录,并解压averaged_perceptron_tagger.zip
文件。Averaged Perceptron Tagger是NLTK提供的另一个工具,用于标记文本中的词性(如名词、动词等)。
整体来看,这些命令似乎是为了准备一些自然语言处理的数据和模型,通过从特定的Git仓库获取数据并解压缩必要的文件来实现。这些操作通常由需要使用NLTK进行开发或研究的人执行。请确保你有足够的权限执行上述命令,并且理解这些操作的目的,以避免不必要的错误或安全风险。
之后使用时服务器即会自动使用已有资源,无需再次下载
3. 是否使用 LlamaIndex 前后对比
3.1 不使用 LlamaIndex RAG(仅API)
浦语官网和硅基流动都提供了InternLM的类OpenAI接口格式的免费的 API,可以访问以下两个了解两个 API 的使用方法和 Key。
运行以下指令,新建一个python文件
cd ~/llamaindex_demo touch test_internlm.py
打开test_internlm.py 贴入以下代码
from openai import OpenAI base_url = "https://internlm-chat.intern-ai.org.cn/puyu/api/v1/" api_key = "sk-请填写准确的 token!" model="internlm2.5-latest" # base_url = "https://api.siliconflow.cn/v1" # api_key = "sk-请填写准确的 token!" # model="internlm/internlm2_5-7b-chat" client = OpenAI( api_key=api_key , base_url=base_url, ) chat_rsp = client.chat.completions.create( model=model, messages=[{"role": "user", "content": "xtuner是什么?"}], ) for choice in chat_rsp.choices: print(choice.message.content)
之后运行
conda activate llamaindex cd ~/llamaindex_demo/ python test_internlm.py
结果为:
回答的效果并不好,并不是我们想要的xtuner。
3.2 使用 API+LlamaIndex
conda activate llamaindex
运行以下命令,获取知识库
cd ~/llamaindex_demo mkdir data cd data git clone https://github.com/InternLM/xtuner.git mv xtuner/README_zh-CN.md ./
运行以下指令,新建一个python文件
cd ~/llamaindex_demo touch llamaindex_RAG.py
打开llamaindex_RAG.py
贴入以下代码
import os os.environ['NLTK_DATA'] = '/root/nltk_data' from llama_index.core import VectorStoreIndex, SimpleDirectoryReader from llama_index.core.settings import Settings from llama_index.embeddings.huggingface import HuggingFaceEmbedding from llama_index.legacy.callbacks import CallbackManager from llama_index.llms.openai_like import OpenAILike # Create an instance of CallbackManager callback_manager = CallbackManager() api_base_url = "https://internlm-chat.intern-ai.org.cn/puyu/api/v1/" model = "internlm2.5-latest" api_key = "请填写 API Key" # api_base_url = "https://api.siliconflow.cn/v1" # model = "internlm/internlm2_5-7b-chat" # api_key = "请填写 API Key" llm =OpenAILike(model=model, api_base=api_base_url, api_key=api_key, is_chat_model=True,callback_manager=callback_manager) #初始化一个HuggingFaceEmbedding对象,用于将文本转换为向量表示 embed_model = HuggingFaceEmbedding( #指定了一个预训练的sentence-transformer模型的路径 model_name="/root/model/sentence-transformer" ) #将创建的嵌入模型赋值给全局设置的embed_model属性, #这样在后续的索引构建过程中就会使用这个模型。 Settings.embed_model = embed_model #初始化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)
之后运行
conda activate llamaindex cd ~/llamaindex_demo/ python llamaindex_RAG.py
注意:第一次运行会下载相关数据需要一段时间,请耐心等待,如中断可能导致第二次运行因为文件损坏报错!!!
结果为:
借助RAG技术后,就能获得我们想要的答案了。
4. LlamaIndex web
运行之前首先安装依赖
pip install streamlit==1.39.0
运行以下指令,新建一个python文件
cd ~/llamaindex_demo touch app.py
打开app.py
贴入以下代码
import streamlit as st from llama_index.core import VectorStoreIndex, SimpleDirectoryReader, Settings from llama_index.embeddings.huggingface import HuggingFaceEmbedding from llama_index.legacy.callbacks import CallbackManager from llama_index.llms.openai_like import OpenAILike # Create an instance of CallbackManager callback_manager = CallbackManager() api_base_url = "https://internlm-chat.intern-ai.org.cn/puyu/api/v1/" model = "internlm2.5-latest" api_key = "请填写 API Key" # api_base_url = "https://api.siliconflow.cn/v1" # model = "internlm/internlm2_5-7b-chat" # api_key = "请填写 API Key" llm =OpenAILike(model=model, api_base=api_base_url, api_key=api_key, is_chat_model=True,callback_manager=callback_manager) st.set_page_config(page_title="llama_index_demo", page_icon="🦜🔗") st.title("llama_index_demo") # 初始化模型 @st.cache_resource def init_models(): embed_model = HuggingFaceEmbedding( model_name="/root/model/sentence-transformer" ) Settings.embed_model = embed_model #用初始化llm Settings.llm = llm documents = SimpleDirectoryReader("/root/llamaindex_demo/data").load_data() index = VectorStoreIndex.from_documents(documents) query_engine = index.as_query_engine() return query_engine # 检查是否需要初始化模型 if 'query_engine' not in st.session_state: st.session_state['query_engine'] = init_models() def greet2(question): response = st.session_state['query_engine'].query(question) return response # Store LLM generated responses if "messages" not in st.session_state.keys(): st.session_state.messages = [{"role": "assistant", "content": "你好,我是你的助手,有什么我可以帮助你的吗?"}] # Display or clear chat messages for message in st.session_state.messages: with st.chat_message(message["role"]): st.write(message["content"]) def clear_chat_history(): st.session_state.messages = [{"role": "assistant", "content": "你好,我是你的助手,有什么我可以帮助你的吗?"}] st.sidebar.button('Clear Chat History', on_click=clear_chat_history) # Function for generating LLaMA2 response def generate_llama_index_response(prompt_input): return greet2(prompt_input) # User-provided prompt if prompt := st.chat_input(): st.session_state.messages.append({"role": "user", "content": prompt}) with st.chat_message("user"): st.write(prompt) # Gegenerate_llama_index_response last message is not from assistant if st.session_state.messages[-1]["role"] != "assistant": with st.chat_message("assistant"): with st.spinner("Thinking..."): response = generate_llama_index_response(prompt) placeholder = st.empty() placeholder.markdown(response) message = {"role": "assistant", "content": response} st.session_state.messages.append(message)
之后运行
streamlit run app.py
然后在命令行点击,红框里的url。
即可进入以下网页,然后就可以开始尝试问问题了。