diff --git a/README.md b/README.md index 8395ef0..6bc715f 100644 --- a/README.md +++ b/README.md @@ -45,16 +45,8 @@ 参见 [版本更新日志](https://github.com/imClumsyPanda/langchain-ChatGLM/releases)。 -## 旧版本升级与知识库迁移 +从`0.1.x`升级过来的用户请注意,在完成[“开发部署 3 设置配置项”](docs/INSTALL.md)之后,需要将现有知识库迁移到新格式,具体见[知识库初始化与迁移](docs/INSTALL.md#知识库初始化与迁移)。 -从`0.1.x`升级过来的用户请注意,在完成“开发部署 3 设置配置项”之后,需要将现有知识库迁移到新格式: -```shell -# 如果知识库已经建立,且知识库类型、嵌入模型无变化,只需以下命令将现有知识库信息添加到数据库即可。 -$ python init_database.py - -# 如果知识库未建立,或者配置文件中的知识库类型、嵌入模型发生变化,需要以下命令进行知识库迁移。 -$ python init_database.py --recreate-vs -``` ## 模型支持 本项目中默认使用的 LLM 模型为 [THUDM/chatglm2-6b](https://huggingface.co/THUDM/chatglm2-6b),默认使用的 Embedding 模型为 [moka-ai/m3e-base](https://huggingface.co/moka-ai/m3e-base) 为例。 diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 20f3e9c..fdb27d5 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -45,4 +45,18 @@ $ pip install -r requirements.txt $ pip install -r requirements_webui.txt ``` -注:使用 `langchain.document_loaders.UnstructuredFileLoader` 进行 `.docx` 等格式非结构化文件接入时,可能需要依据文档进行其他依赖包的安装,请参考 [langchain 文档](https://python.langchain.com/en/latest/modules/indexes/document_loaders/examples/unstructured_file.html)。 \ No newline at end of file +注:使用 `langchain.document_loaders.UnstructuredFileLoader` 进行 `.docx` 等格式非结构化文件接入时,可能需要依据文档进行其他依赖包的安装,请参考 [langchain 文档](https://python.langchain.com/en/latest/modules/indexes/document_loaders/examples/unstructured_file.html)。 + +## 知识库初始化与迁移 + +当前项目的知识库信息存储在数据库中,在正式运行项目之前请先初始化数据库(我们强烈建议您在执行操作前备份您的知识文件)。 + +- 如果您是第一次运行本项目,知识库尚未建立,或者配置文件中的知识库类型、嵌入模型发生变化,需要以下命令初始化或重建知识库: + ```shell + $ python init_database.py --recreate-vs + ``` + +- 如果您是从"`0.1.x`"版升级过来的用户,识库已经建立,且知识库类型、嵌入模型无变化,只需以下命令将现有知识库信息添加到数据库即可: + ```shell + $ python init_database.py + ```