diff --git a/README.md b/README.md index d8139cd..9f3ec7a 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ * [3. 设置配置项](README.md#3.-设置配置项) * [4. 知识库初始化与迁移](README.md#4.-知识库初始化与迁移) * [5. 启动 API 服务或 Web UI](README.md#5.-启动-API-服务或-Web-UI) + * [6. 一键启动](README.md#6.-一键启动) * [常见问题](README.md#常见问题) * [路线图](README.md#路线图) * [项目交流群](README.md#项目交流群) @@ -357,19 +358,17 @@ $ streamlit run webui.py --server.port 666 --- -### 6 一键启动 +### 6. 一键启动 -**!!!注意:** +⚠️ **注意:** -**1.一键启动脚本仅适用于linux和mac设备,win平台请使用wls;** +**1. 一键启动脚本仅适用于 Linux 和 Mac 设备, Winodws 平台请使用 WLS;** -**2.加载非默认模型需要用命令行参数--model-path-address指定指定模型,不会读取model_config.py配置;** +**2. 加载非默认模型需要用命令行参数 `--model-path-address` 指定指定模型,不会读取 `model_config.py` 配置。** -**!!!** +#### 6.1 API 服务一键启动脚本 -#### 6.1 api服务一键启动脚本 - -新增api一键启动脚本,可一键开启fastchat后台服务及本项目提供的langchain api服务,调用示例: +新增 API 一键启动脚本,可一键开启 FastChat 后台服务及本项目提供的 API 服务,调用示例: 调用默认模型: @@ -389,7 +388,7 @@ $ python server/api_allinone.py --model-path-address model1@host1@port1 model2@h python server/api_allinone.py --model-path-address model@host@port --num-gpus 2 --gpus 0,1 --max-gpu-memory 10GiB ``` -其他参数详见各脚本及fastchat服务说明。 +其他参数详见各脚本及 FastChat 服务说明。 #### 6.2 webui一键启动脚本 @@ -399,7 +398,7 @@ python server/api_allinone.py --model-path-address model@host@port --num-gpus 2 $ python webui_allinone.py ``` -调用远程api服务: +调用远程 API 服务: ```shell $ python webui_allinone.py --use-remote-api @@ -425,7 +424,7 @@ $ python webui_alline.py --model-path-address model@host@port --num-gpus 2 --gpu 其他参数详见各脚本及fastchat服务说明。 -上述两个一键启动脚本会后台运行多个服务,如要停止所有服务,可使用shutdown_all.sh脚本: +上述两个一键启动脚本会后台运行多个服务,如要停止所有服务,可使用 `shutdown_all.sh` 脚本: ```shell bash shutdown_all.sh