From 29738c071c3669b428b448e6c600ea4a12e87776 Mon Sep 17 00:00:00 2001 From: liunux4odoo Date: Fri, 25 Aug 2023 08:19:58 +0800 Subject: [PATCH] update readme about startup.py --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 991487b..bf3a5ae 100644 --- a/README.md +++ b/README.md @@ -214,12 +214,12 @@ embedding_model_dict = { 当前项目的知识库信息存储在数据库中，在正式运行项目之前请先初始化数据库（我们强烈建议您在执行操作前备份您的知识文件）。 -- 如果您是从 `0.1.x` 版本升级过来的用户，针对已建立的知识库，请确认知识库的向量库类型、Embedding 模型 `configs/model_config.py` 中默认设置一致，如无变化只需以下命令将现有知识库信息添加到数据库即可： +- 如果您是从 `0.1.x` 版本升级过来的用户，针对已建立的知识库，请确认知识库的向量库类型、Embedding 模型与 `configs/model_config.py` 中默认设置一致，如无变化只需以下命令将现有知识库信息添加到数据库即可： ```shell $ python init_database.py ``` -- 如果您是第一次运行本项目，知识库尚未建立，或者配置文件中的知识库类型、嵌入模型发生变化，需要以下命令初始化或重建知识库： +- 如果您是第一次运行本项目，知识库尚未建立，或者配置文件中的知识库类型、嵌入模型发生变化，或者之前的向量库没有开启`normalize_L2`，需要以下命令初始化或重建知识库： ```shell $ python init_database.py --recreate-vs @@ -361,13 +361,13 @@ $ streamlit run webui.py --server.port 666 更新一键启动脚本 startup.py,一键启动所有 Fastchat 服务、API 服务、WebUI 服务，示例代码： ```shell -$ python startup.py --all-webui +$ python startup.py -a ``` -并可使用 `Ctrl + C` 直接关闭所有运行服务。 +并可使用 `Ctrl + C` 直接关闭所有运行服务。如果一次结束不了，可以多按几次。 -可选参数包括 `--all-webui`, `--all-api`, `--llm-api`, `--controller`, `--openai-api`, -`--model-worker`, `--api`, `--webui`，其中： +可选参数包括 `-a (或--all-webui)`, `--all-api`, `--llm-api`, `-c (或--controller)`, `--openai-api`, +`-m (或--model-worker)`, `--api`, `--webui`，其中： - `--all-webui` 为一键启动 WebUI 所有依赖服务； @@ -385,6 +385,8 @@ $ python startup.py --all-webui $ python startup.py --all-webui --model-name Qwen-7B-Chat ``` +更多信息可通过`python startup.py -h`查看。 + **注意：** **1. startup 脚本用多进程方式启动各模块的服务，可能会导致打印顺序问题，请等待全部服务发起后再调用，并根据默认或指定端口调用服务（默认 LLM API 服务端口：`127.0.0.1:8888`,默认 API 服务端口：`127.0.0.1:7861`,默认 WebUI 服务端口：`本机IP：8501`)**