所有tag为书生大模型的文档，连同本文档在内，为书生大模型实战营训练内容，文档中的内容并不局限于实战营本身，但算力平台均首选上海AI实验室开发的云端集成开发环境InternStudio，开发手册和InternStudio算力平台的相关内容可以点击链接跳转。

1.前置知识

1.1 什么是RAG

给模型注入新知识的方式，可以简单分为两种方式：一种是内部的，即更新模型的权重，另一个就是外部的方式，给模型注入格外的上下文或者说外部信息，不改变它的的权重。

第一种方式，改变了模型的权重即进行模型训练，这是一件代价比较大的事情。第二种方式，并不改变模型的权重，只是给模型引入格外的信息。类比人类考试的过程，第一种方式相当于你通过不断学习（训练）最后参加了高考（回答问题），第二章方式相当于你选择了开卷考。 对比两种注入知识方式，第二种更容易实现。RAG正是这种方式。它能够让基础模型实现非参数知识更新，无需训练就可以掌握新领域的知识。

image
image

1.2 LlamaIndex

LlamaIndex（以前称为GPT Index）是一个开源框架，旨在帮助开发者高效地将大语言模型集成到各种本地或外部数据源中。其核心功能是通过构建定制化的索引，使得语言模型能够更智能地查询和处理与特定应用相关的知识。LlamaIndex的主要目标是填补语言模型与真实应用之间的鸿沟，使这些模型能够与文档、数据库、API等外部知识源无缝结合，从而提升模型的表现。

  • 多种索引类型：
    • 支持构建多种形式的索引，例如树状索引、向量索引、关键词索引等，以适配不同的数据形式和查询需求。
    • 例如：将大量文本分割为小的片段并构建向量索引，便于快速的相似性搜索。
  • 灵活的数据集成：
    • 支持从多种数据源中加载数据，如文件（PDF、Word、CSV等）、数据库、API、网页等。
    • 提供工具将这些数据转换为适合LLM理解的格式。
  • 与LLM高效交互：
    • 索引作为一种中介，将外部知识与LLM紧密结合，允许模型在查询过程中动态获取相关的背景信息。
    • 支持复杂的查询，包括语义搜索、多轮问答和摘要生成。
  • 模块化设计：
    • LlamaIndex的架构高度模块化，方便开发者根据需要进行定制和扩展。

2.调用API应用RAG

2.1 配置环境

与之前文章的步骤相同，用VS Code通过SSH连接算力平台的开发机（这里选择了30%A100性能的开发机，Cuda版本为12.2）。

image
image

创建一个新的环境。

conda create -n llamaindex python=3.10
image
image

安装Llamaindex和一些依赖包。

pip install einops==0.7.0 protobuf==5.26.1
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

2.2 下载Embedding模型

源词向量模型选用Sentence Transformer（也可以选用别的开源词向量模型来进行Embedding，目前选用这个模型是相对轻量、支持中文且效果较好的）。

如果要从Hugging Face运行以下指令，新建一个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')

更多关于镜像使用可以移步至HF Mirror 查看。 此外，国内更加推荐从modelscope下载，毕竟无需魔法。

apt-get install git-lfs
cd /root/model/
git clone https://www.modelscope.cn/Ceceliachenen/paraphrase-multilingual-MiniLM-L12-v2.git
mv paraphrase-multilingual-MiniLM-L12-v2 sentence-transformer

2.3 下载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

之后使用时服务器会自动使用已有资源，无需再次下载。

2.4 RAG效果对比

浦语官网和硅基流动都提供了InternLM的类OpenAI接口格式的免费的API(其他支持类OpenAI调用泛式的大模型也可以，具体可以查看各类官方文档。)，可以访问以下两个了解两个API 的使用方法和Key。

浦语官方API：https://internlm.intern-ai.org.cn/api/document

硅基流动：https://cloud.siliconflow.cn/models?mfs=internlm

运行以下指令，新建一个python文件。

cd ~/llamaindex_demo
touch 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)

运行，可以得到回复如下：

image
image
对不起，我不太了解您所说的内容。如果您对科技产品或者音乐软件感兴趣，我会很乐意提供相关知识和信息。我们鼓励开放、理性和建设性的讨论，以共同营造一个积极、健康的网络环境。如果您有其他问题，欢迎随时向我提问。

很明显，大模型现在并不知道xtuner是什么。现在可以尝试将这些知识喂给它。

首先，需要将想要喂给它的知识库准备好。

cd ~/llamaindex_demo
mkdir data
cd data
git clone https://github.com/InternLM/xtuner.git
mv xtuner/README_zh-CN.md ./
image
image

运行以下指令，新建一个python文件

cd ~/llamaindex_demo
touch llamaindex_RAG.py
image
image

这一次可以看到它已经能输出相关内容了，这证明它的确学习到了知识库中的内容。

3.本地部署并使用RAG

这一节尝试一下本地部署大语言模型InternLM2-Chat-1.8B，并应用RAG

3.1 配置环境

进入开发机后，创建新的 conda 环境，命名为llamaindex_local，在命令行模式下运行：

conda create -n llamaindex_local python=3.10
conda activate llamaindex_local

然后安装相关依赖：

pip install einops==0.7.0 protobuf==5.26.1
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
pip install llama-index-embeddings-huggingface==0.2.0 llama-index-embeddings-instructor==0.1.3
conda install pytorch==2.0.1 torchvision==0.15.2 torchaudio==2.0.2 pytorch-cuda=11.7 -c pytorch -c nvidia

安装完成以后，验证Pytorch是否正确安装并使用了指定的CUDA版本：

import torch
print(torch.__version__)        # 应输出类似 '2.0.1'
print(torch.version.cuda)       # 应输出 '11.7'
print(torch.cuda.is_available())# 应输出 True
image
image

3.2 RAG效果对比

首先需要下载InternLM2-1.8B模型做测试，下载方法可以参考这篇文章。

运行以下指令，把InternLM2-1.8B软连接出来。

cd ~/model
ln -s /root/share/new_models/Shanghai_AI_Laboratory/internlm2-chat-1_8b/ ./

运行以下指令，新建一个 python 文件：

cd ~/llamaindex_demo
touch 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)

回答如下：

image
image

可以观察到回答非常奇怪，根本不符合预期。

打开先前创建的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)
image
image

这一次就明显符合要求了，可见它确实读取了相关的知识。

4.Web预览

运行之前首先安装依赖(安装后可能会有版本冲突的报错，可以忽略)：

pip install streamlit==1.36.0

运行以下指令，新建一个 python 文件：

cd ~/llamaindex_demo
touch app.py

输入以下代码：

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

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 = 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}
    )
    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：

image
image

最后就可以尝试问答了：

image
image

比在终端里问答强多了。