0 项目介绍
书生大模型实战营三期进阶岛 增加了MindSearch 快速部署任务关卡。之前的任务是在彩蛋岛的任务,可能之前彩蛋岛的任务中用到了DuckDuckGoSearch 这个是国外网络才好访问,实际使用过程中需要通过一些魔法才能解决此任务。很多小伙伴卡在网络这块,所以训练营对次任务进行了改进,改成了使用 HuggingFace
space +硅基流动的 API Key的方式部署。本次任务带大家一起完成HuggingFace space 这种部署方式。
如果小伙伴对之前的部署方式感兴趣可以关注这篇文章
B站
微信公众号
CSDN
系统huggingface space 体验地址
1 获取硅基流动 API Key
因为要使用硅基流动的 API Key,所以接下来便是注册并获取 API Key 了。
首先,我们打开 https://account.siliconflow.cn/login 来注册硅基流动的账号(如果注册过,则直接登录即可)。
在完成注册后,打开 https://cloud.siliconflow.cn/account/ak 来准备 API Key。首先创建新 API 密钥,然后点击密钥进行复制,以备后续使用。
[
2 使用github
Codespaces
进入Codespaces 浏览器会自动在新的页面打开一个web版的vscode
然后我们新建一个目录用于存放 MindSearch 的相关代码,并把 MindSearch 仓库 clone 下来。在终端中运行下面的命令:
mkdir -p /workspaces/mindsearch
cd /workspaces/mindsearch
git clone https://github.com/InternLM/MindSearch.git
cd MindSearch && git checkout b832275 && cd ..
接下来,我们创建一个 conda 环境来安装相关依赖。
# 创建环境
conda create -n mindsearch python=3.10 -y
# 激活环境
conda activate mindsearch
source activate
# 安装依赖
pip install -r /workspaces/mindsearch/MindSearch/requirements.txt
3.启动 MindSearch
启动后端
由于硅基流动 API 的相关配置已经集成在了 MindSearch 中,所以我们可以直接执行下面的代码来启动 MindSearch 的后端
# 硅基流动 API Key
export SILICON_API_KEY=
conda activate mindsearch
cd /workspaces/mindsearch/MindSearch
python -m mindsearch.app --lang cn --model_format internlm_silicon --search_engine DuckDuckGoSearch
看到以上画面服务已经启动完成。
启动前端
在后端启动完成后,我们打开新终端运行如下命令来启动 MindSearch 的前端。
conda activate mindsearch
cd /workspaces/mindsearch/MindSearch
python frontend/mindsearch_gradio.py
我们打开gradio 自动创建的二级域名URL 地址https://6af4cab6a65b06dec6.gradio.live/
然后就可以即刻体验啦。
使用硅基流动 API +无网络限制的DuckDuckGoSearch 搜索这样的AI 搜索还挺快的,哈哈。
4.部署到 HuggingFace Space
我们首先打开 https://huggingface.co/spaces ,并点击 Create new Space,如下图所示
在输入 Space name 并选择 License 后,选择配置如下所示。
点击 create space
然后,我们进入 Settings,配置硅基流动的 API Key。如下图所示
选择 New secrets,name 一栏输入 SILICON_API_KEY,value 一栏输入你的 API Key 的内容。
最后,我们先新建一个目录,准备提交到 HuggingFace Space 的全部文件
# 创建新目录
mkdir -p /workspaces/mindsearch/mindsearch_deploy
# 准备复制文件
cd /workspaces/mindsearch
cp -r /workspaces/mindsearch/MindSearch/mindsearch /workspaces/mindsearch/mindsearch_deploy
cp /workspaces/mindsearch/MindSearch/requirements.txt /workspaces/mindsearch/mindsearch_deploy
# 创建 app.py 作为程序入口
touch /workspaces/mindsearch/mindsearch_deploy/app.py
其中,app.py 的内容如下:
import json
import os
import gradio as gr
import requests
from lagent.schema import AgentStatusCode
os.system("python -m mindsearch.app --lang cn --model_format internlm_silicon &")
PLANNER_HISTORY = []
SEARCHER_HISTORY = []
def rst_mem(history_planner: list, history_searcher: list):
'''
Reset the chatbot memory.
'''
history_planner = []
history_searcher = []
if PLANNER_HISTORY:
PLANNER_HISTORY.clear()
return history_planner, history_searcher
def format_response(gr_history, agent_return):
if agent_return['state'] in [
AgentStatusCode.STREAM_ING, AgentStatusCode.ANSWER_ING
]:
gr_history[-1][1] = agent_return['response']
elif agent_return['state'] == AgentStatusCode.PLUGIN_START:
thought = gr_history[-1][1].split('```')[0]
if agent_return['response'].startswith('```'):
gr_history[-1][1] = thought + '\n' + agent_return['response']
elif agent_return['state'] == AgentStatusCode.PLUGIN_END:
thought = gr_history[-1][1].split('```')[0]
if isinstance(agent_return['response'], dict):
gr_history[-1][
1] = thought + '\n' + f'```json\n{json.dumps(agent_return["response"], ensure_ascii=False, indent=4)}\n```' # noqa: E501
elif agent_return['state'] == AgentStatusCode.PLUGIN_RETURN:
assert agent_return['inner_steps'][-1]['role'] == 'environment'
item = agent_return['inner_steps'][-1]
gr_history.append([
None,
f"```json\n{json.dumps(item['content'], ensure_ascii=False, indent=4)}\n```"
])
gr_history.append([None, ''])
return
def predict(history_planner, history_searcher):
def streaming(raw_response):
for chunk in raw_response.iter_lines(chunk_size=8192,
decode_unicode=False,
delimiter=b'\n'):
if chunk:
decoded = chunk.decode('utf-8')
if decoded == '\r':
continue
if decoded[:6] == 'data: ':
decoded = decoded[6:]
elif decoded.startswith(': ping - '):
continue
response = json.loads(decoded)
yield (response['response'], response['current_node'])
global PLANNER_HISTORY
PLANNER_HISTORY.append(dict(role='user', content=history_planner[-1][0]))
new_search_turn = True
url = 'http://localhost:8002/solve'
headers = {'Content-Type': 'application/json'}
data = {'inputs': PLANNER_HISTORY}
raw_response = requests.post(url,
headers=headers,
data=json.dumps(data),
timeout=20,
stream=True)
for resp in streaming(raw_response):
agent_return, node_name = resp
if node_name:
if node_name in ['root', 'response']:
continue
agent_return = agent_return['nodes'][node_name]['detail']
if new_search_turn:
history_searcher.append([agent_return['content'], ''])
new_search_turn = False
format_response(history_searcher, agent_return)
if agent_return['state'] == AgentStatusCode.END:
new_search_turn = True
yield history_planner, history_searcher
else:
new_search_turn = True
format_response(history_planner, agent_return)
if agent_return['state'] == AgentStatusCode.END:
PLANNER_HISTORY = agent_return['inner_steps']
yield history_planner, history_searcher
return history_planner, history_searcher
with gr.Blocks() as demo:
gr.HTML("""<h1 align="center">MindSearch Gradio Demo</h1>""")
gr.HTML("""<p style="text-align: center; font-family: Arial, sans-serif;">MindSearch is an open-source AI Search Engine Framework with Perplexity.ai Pro performance. You can deploy your own Perplexity.ai-style search engine using either closed-source LLMs (GPT, Claude) or open-source LLMs (InternLM2.5-7b-chat).</p>""")
gr.HTML("""
<div style="text-align: center; font-size: 16px;">
<a href="https://github.com/InternLM/MindSearch" style="margin-right: 15px; text-decoration: none; color: #4A90E2;">🔗 GitHub</a>
<a href="https://arxiv.org/abs/2407.20183" style="margin-right: 15px; text-decoration: none; color: #4A90E2;">📄 Arxiv</a>
<a href="https://huggingface.co/papers/2407.20183" style="margin-right: 15px; text-decoration: none; color: #4A90E2;">📚 Hugging Face Papers</a>
<a href="https://huggingface.co/spaces/internlm/MindSearch" style="text-decoration: none; color: #4A90E2;">🤗 Hugging Face Demo</a>
</div>
""")
with gr.Row():
with gr.Column(scale=10):
with gr.Row():
with gr.Column():
planner = gr.Chatbot(label='planner',
height=700,
show_label=True,
show_copy_button=True,
bubble_full_width=False,
render_markdown=True)
with gr.Column():
searcher = gr.Chatbot(label='searcher',
height=700,
show_label=True,
show_copy_button=True,
bubble_full_width=False,
render_markdown=True)
with gr.Row():
user_input = gr.Textbox(show_label=False,
placeholder='帮我搜索一下 InternLM 开源体系',
lines=5,
container=False)
with gr.Row():
with gr.Column(scale=2):
submitBtn = gr.Button('Submit')
with gr.Column(scale=1, min_width=20):
emptyBtn = gr.Button('Clear History')
def user(query, history):
return '', history + [[query, '']]
submitBtn.click(user, [user_input, planner], [user_input, planner],
queue=False).then(predict, [planner, searcher],
[planner, searcher])
emptyBtn.click(rst_mem, [planner, searcher], [planner, searcher],
queue=False)
demo.queue()
demo.launch(server_name='0.0.0.0',
server_port=7860,
inbrowser=True,
share=True)
我们从huggingface 把我们的空项目下载下来
回到Codespaces shell 命令行窗口中执行
cd /workspaces/codespaces-blank
# 下面的代码注意不能直接用把xxxx 换成你的token; huggingface.co/spaces/zhouhui/mindsearch 换成你的项目URL
git clone https://zhouhui:xxxx@huggingface.co/spaces/zhouhui/mindsearch
我们需要将上面mindsearch_deploy 文件下内 app.py requirements.txt 以及mindsearch 目录下的文件复制到/workspaces/codespaces-blank/mindsearch
cd /workspaces/mindsearch/mindsearch_deploy
cp app.py /workspaces/codespaces-blank/mindsearch
cp requirements.txt /workspaces/codespaces-blank/mindsearch
cp -r mindsearch/ /workspaces/codespaces-blank/mindsearch
Then commit and push:
cd /workspaces/codespaces-blank/mindsearch
git init
git add .
git commit -m "Add application file"
# 下面的代码注意不能直接用把xxxx 换成你的token; huggingface.co/spaces/zhouhui/mindsearch 换成你的项目URL 上面步骤有了,这步可以不用
#git remote set-url origin https://zhouhui:XXXXXXX@huggingface.co/spaces/zhouhui/mindsearch
git push origin
我们打开huggingface space 上传的文件目录如下
当运行成功后我们验证,打开https://huggingface.co/spaces/zhouhui/mindsearch 地址
就可以测试了
注意事项: 2023 年 10 月 1 日 开始Hugging Face不再接受密码作为命令行 Git 操作的认证方式,也就是通过账号和密码的方式是不能发访问的,否则会导致git 代码上传不了的问题。
参考文档https://huggingface.co/blog/zh/password-git-deprecation
5 .huggingface ssh设置(补充版本可以不看)
生成ssh的key 我们那本地电脑来做测试
ssh-keygen -t ed25519 -C "wwwzhouhui2024@gmail.com"
这样你的windows平台上会通过ssh-agent 生成id_ed25519.pub 和id_ed25519
windows 平台如果没有开启ssh-agent 导致上面没有创建成功 可以参考https://blog.csdn.net/m0_63969219/article/details/124650073
设置key存储的位置,打开https://huggingface.co/settings/profile,选择 SSH and GPG keys
点击" add ssh key"
打开文件,将文件中的key复制到hf中
配置成功后,我们在本地电脑上
ssh -T git@hf.co
看到这个说明我们本地电脑和huggingface ssh设置成功。
参考https://huggingface.co/docs/hub/security-git-ssh
参考文献
https://github.com/InternLM/Tutorial/blob/camp3/docs/L2/MindSearch/readme.md
https://github.com/InternLM/Tutorial/blob/camp3/docs/L2/MindSearch/readme_github.md