update README.md

This commit is contained in:
imClumsyPanda 2023-08-12 16:36:14 +08:00
parent 90eb45ac46
commit df6ef705b0
1 changed files with 18 additions and 1 deletions

View File

@ -17,6 +17,8 @@
* [路线图](README.md#路线图)
* [项目交流群](README.md#项目交流群)
---
## 介绍
🤖️ 一种利用 [langchain](https://github.com/hwchase17/langchain) 思想实现的基于本地知识库的问答应用,目标期望建立一套对中文场景与开源模型支持友好、可离线运行的知识库问答解决方案。
@ -39,6 +41,8 @@
🌐 AutoDL 镜像及 Docker 镜像制作中
---
## 变更日志
参见 [版本更新日志](https://github.com/imClumsyPanda/langchain-ChatGLM/releases)。
@ -55,6 +59,8 @@
6. 项目中扩充了对不同类型向量库的支持,除支持 [FAISS](https://github.com/facebookresearch/faiss) 向量库外,还提供 [Milvus](https://github.com/milvus-io/milvus), [PGVector](https://github.com/pgvector/pgvector) 向量库的接入;
7. 项目中搜索引擎对话,除 Bing 搜索外,增加 DuckDuckGo 搜索选项DuckDuckGo 搜索无需配置 API Key在可访问国外服务环境下可直接使用。
---
## 模型支持
本项目中默认使用的 LLM 模型为 [THUDM/chatglm2-6b](https://huggingface.co/THUDM/chatglm2-6b),默认使用的 Embedding 模型为 [moka-ai/m3e-base](https://huggingface.co/moka-ai/m3e-base) 为例。
@ -117,10 +123,14 @@
- [nghuyong/ernie-3.0-nano-zh](https://huggingface.co/nghuyong/ernie-3.0-nano-zh)
- [nghuyong/ernie-3.0-base-zh](https://huggingface.co/nghuyong/ernie-3.0-base-zh)
---
## Docker 部署
AutoDL 镜像及 Docker 镜像制作中,将会在上传完成后增加。
---
## 开发部署
### 软件需求
@ -133,6 +143,7 @@ AutoDL 镜像及 Docker 镜像制作中,将会在上传完成后增加。
**请注意:** `0.2.0`及更新版本的依赖包与`0.1.x`版本依赖包可能发生冲突,强烈建议新建环境后重新安装依赖包。
### 2. 下载模型至本地
如需在本地或离线环境下运行本项目,需要首先将项目所需的模型下载至本地,通常开源 LLM 与 Embedding 模型可以从 [HuggingFace](https://huggingface.co/models) 下载。
@ -241,10 +252,14 @@ $ streamlit run webui.py --server.port 666
![](img/webui_020_1.png)
### 常见问题
---
## 常见问题
参见 [常见问题](docs/FAQ.md)。
---
## 路线图
- [X] Langchain 应用
@ -277,6 +292,8 @@ $ streamlit run webui.py --server.port 666
- [X] Web UI
- [X] 基于 Streamlit 的 Web UI
---
## 项目交流群
<img src="img/qr_code_50.jpg" alt="二维码" width="300" height="300" />