From c50e988f5ac0dc0b0424e1abc57c3eebc488b3c2 Mon Sep 17 00:00:00 2001 From: zR <2448370773@qq.com> Date: Mon, 22 Jan 2024 13:24:11 +0800 Subject: [PATCH] =?UTF-8?q?readme=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 80 +++++++++++++++++++++++++++++++++++++--------------- README_en.md | 16 +++++++---- 2 files changed, 68 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 3072bdf7..20e67a9d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ ![](img/logo-long-chatchat-trans-v2.png) - 🌍 [READ THIS IN ENGLISH](README_en.md) 📃 **LangChain-Chatchat** (原 Langchain-ChatGLM) 基于 ChatGLM 等大语言模型与 Langchain 等应用框架实现，开源、可离线部署的检索增强生成(RAG)大模型知识库项目。 +⚠️`0.2.10`将会是`0.2.x`系列的最后一个版本，`0.2.x`系列版本将会停止更新和技术支持，全力研发具有更强应用性的 `Langchain-Chatchat 0.3.x`。 + --- ## 目录 @@ -14,23 +15,31 @@ * [介绍](README.md#介绍) * [解决的痛点](README.md#解决的痛点) * [快速上手](README.md#快速上手) - * [1. 环境配置](README.md#1-环境配置) - * [2. 模型下载](README.md#2-模型下载) - * [3. 初始化知识库和配置文件](README.md#3-初始化知识库和配置文件) - * [4. 一键启动](README.md#4-一键启动) - * [5. 启动界面示例](README.md#5-启动界面示例) + * [1. 环境配置](README.md#1-环境配置) + * [2. 模型下载](README.md#2-模型下载) + * [3. 初始化知识库和配置文件](README.md#3-初始化知识库和配置文件) + * [4. 一键启动](README.md#4-一键启动) + * [5. 启动界面示例](README.md#5-启动界面示例) * [联系我们](README.md#联系我们) - ## 介绍 -🤖️ 一种利用 [langchain](https://github.com/hwchase17/langchain) 思想实现的基于本地知识库的问答应用，目标期望建立一套对中文场景与开源模型支持友好、可离线运行的知识库问答解决方案。 +🤖️ 一种利用 [langchain](https://github.com/langchain-ai/langchain) +思想实现的基于本地知识库的问答应用，目标期望建立一套对中文场景与开源模型支持友好、可离线运行的知识库问答解决方案。 -💡 受 [GanymedeNil](https://github.com/GanymedeNil) 的项目 [document.ai](https://github.com/GanymedeNil/document.ai) 和 [AlexZhangji](https://github.com/AlexZhangji) 创建的 [ChatGLM-6B Pull Request](https://github.com/THUDM/ChatGLM-6B/pull/216) 启发，建立了全流程可使用开源模型实现的本地知识库问答应用。本项目的最新版本中通过使用 [FastChat](https://github.com/lm-sys/FastChat) 接入 Vicuna, Alpaca, LLaMA, Koala, RWKV 等模型，依托于 [langchain](https://github.com/langchain-ai/langchain) 框架支持通过基于 [FastAPI](https://github.com/tiangolo/fastapi) 提供的 API 调用服务，或使用基于 [Streamlit](https://github.com/streamlit/streamlit) 的 WebUI 进行操作。 +💡 受 [GanymedeNil](https://github.com/GanymedeNil) 的项目 [document.ai](https://github.com/GanymedeNil/document.ai) +和 [AlexZhangji](https://github.com/AlexZhangji) +创建的 [ChatGLM-6B Pull Request](https://github.com/THUDM/ChatGLM-6B/pull/216) +启发，建立了全流程可使用开源模型实现的本地知识库问答应用。本项目的最新版本中通过使用 [FastChat](https://github.com/lm-sys/FastChat) +接入 Vicuna, Alpaca, LLaMA, Koala, RWKV 等模型，依托于 [langchain](https://github.com/langchain-ai/langchain) +框架支持通过基于 [FastAPI](https://github.com/tiangolo/fastapi) 提供的 API +调用服务，或使用基于 [Streamlit](https://github.com/streamlit/streamlit) 的 WebUI 进行操作。 -✅ 依托于本项目支持的开源 LLM 与 Embedding 模型，本项目可实现全部使用**开源**模型**离线私有部署**。与此同时，本项目也支持 OpenAI GPT API 的调用，并将在后续持续扩充对各类模型及模型 API 的接入。 +✅ 依托于本项目支持的开源 LLM 与 Embedding 模型，本项目可实现全部使用**开源**模型**离线私有部署**。与此同时，本项目也支持 +OpenAI GPT API 的调用，并将在后续持续扩充对各类模型及模型 API 的接入。 -⛓️ 本项目实现原理如下图所示，过程包括加载文件 -> 读取文本 -> 文本分割 -> 文本向量化 -> 问句向量化 -> 在文本向量中匹配出与问句向量最相似的 `top k`个 -> 匹配出的文本作为上下文和问题一起添加到 `prompt`中 -> 提交给 `LLM`生成回答。 +⛓️ 本项目实现原理如下图所示，过程包括加载文件 -> 读取文本 -> 文本分割 -> 文本向量化 -> 问句向量化 -> +在文本向量中匹配出与问句向量最相似的 `top k`个 -> 匹配出的文本作为上下文和问题一起添加到 `prompt`中 -> 提交给 `LLM`生成回答。 📺 [原理介绍视频](https://www.bilibili.com/video/BV13M4y1e7cN/?share_source=copy_web&vd_source=e6c5aafe684f30fbe41925d61ca6d514) @@ -42,7 +51,8 @@ 🚩 本项目未涉及微调、训练过程，但可利用微调或训练对本项目效果进行优化。 -🌐 [AutoDL 镜像](https://www.codewithgpu.com/i/chatchat-space/Langchain-Chatchat/Langchain-Chatchat) 中 `v13` 版本所使用代码已更新至本项目 `v0.2.9` 版本。 +🌐 [AutoDL 镜像](https://www.codewithgpu.com/i/chatchat-space/Langchain-Chatchat/Langchain-Chatchat) 中 `v13` +版本所使用代码已更新至本项目 `v0.2.9` 版本。 🐳 [Docker 镜像](registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.6) 已经更新到 ```0.2.7``` 版本。 @@ -52,7 +62,10 @@ docker run -d --gpus all -p 80:8501 registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.7 ``` -🧩 本项目有一个非常完整的[Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/) ， README只是一个简单的介绍，__仅仅是入门教程，能够基础运行__。 如果你想要更深入的了解本项目，或者想对本项目做出贡献。请移步 [Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/) 界面 +🧩 本项目有一个非常完整的[Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/) ， README只是一个简单的介绍，_ +_仅仅是入门教程，能够基础运行__。 +如果你想要更深入的了解本项目，或者想对本项目做出贡献。请移步 [Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/) +界面 ## 解决的痛点 @@ -62,17 +75,19 @@ docker run -d --gpus all -p 80:8501 registry.cn-beijing.aliyuncs.com/chatchat/ch 我们支持市面上主流的本地大语言模型和Embedding模型，支持开源的本地向量数据库。 支持列表详见[Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/) - ## 快速上手 ### 1. 环境配置 -+ 首先，确保你的机器安装了 Python 3.8 - 3.11 ++ 首先，确保你的机器安装了 Python 3.8 - 3.11 (我们强烈推荐使用 Python3.11)。 + ``` $ python --version Python 3.11.7 ``` + 接着，创建一个虚拟环境，并在虚拟环境内安装项目的依赖 + ```shell # 拉取仓库 @@ -88,33 +103,44 @@ $ pip install -r requirements_webui.txt # 默认依赖包括基本运行环境（FAISS向量库）。如果要使用 milvus/pg_vector 等向量库，请将 requirements.txt 中相应依赖取消注释再安装。 ``` -请注意，LangChain-Chatchat `0.2.x` 系列是针对 Langchain `0.0.x` 系列版本的，如果你使用的是 Langchain `0.1.x` 系列版本，需要降级。 + +请注意，LangChain-Chatchat `0.2.x` 系列是针对 Langchain `0.0.x` 系列版本的，如果你使用的是 Langchain `0.1.x` +系列版本，需要降级您的`Langchain`版本。 + ### 2， 模型下载 -如需在本地或离线环境下运行本项目，需要首先将项目所需的模型下载至本地，通常开源 LLM 与 Embedding 模型可以从 [HuggingFace](https://huggingface.co/models) 下载。 +如需在本地或离线环境下运行本项目，需要首先将项目所需的模型下载至本地，通常开源 LLM 与 Embedding +模型可以从 [HuggingFace](https://huggingface.co/models) 下载。 -以本项目中默认使用的 LLM 模型 [THUDM/ChatGLM3-6B](https://huggingface.co/THUDM/chatglm3-6b) 与 Embedding 模型 [BAAI/bge-large-zh](https://huggingface.co/BAAI/bge-large-zh) 为例： +以本项目中默认使用的 LLM 模型 [THUDM/ChatGLM3-6B](https://huggingface.co/THUDM/chatglm3-6b) 与 Embedding +模型 [BAAI/bge-large-zh](https://huggingface.co/BAAI/bge-large-zh) 为例： -下载模型需要先[安装 Git LFS](https://docs.github.com/zh/repositories/working-with-files/managing-large-files/installing-git-large-file-storage)，然后运行 +下载模型需要先[安装 Git LFS](https://docs.github.com/zh/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) +，然后运行 ```Shell $ git lfs install $ git clone https://huggingface.co/THUDM/chatglm3-6b $ git clone https://huggingface.co/BAAI/bge-large-zh ``` + ### 3. 初始化知识库和配置文件 按照下列方式初始化自己的知识库和简单的复制配置文件 + ```shell $ python copy_config_example.py $ python init_database.py --recreate-vs ``` + ### 4. 一键启动 按照以下命令启动项目 + ```shell $ python startup.py -a ``` + ### 5. 启动界面示例 如果正常启动，你将能看到以下界面 @@ -133,28 +159,36 @@ $ python startup.py -a ![](img/init_knowledge_base.jpg) - ### 注意 -以上方式只是为了快速上手，如果需要更多的功能和自定义启动方式 ，请参考[Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/) +以上方式只是为了快速上手，如果需要更多的功能和自定义启动方式 +，请参考[Wiki](https://github.com/chatchat-space/Langchain-Chatchat/wiki/) --- + ## 项目里程碑 + `2023年4月`: `Langchain-ChatGLM 0.1.0` 发布，支持基于 ChatGLM-6B 模型的本地知识库问答。 + `2023年8月`: `Langchain-ChatGLM` 改名为 `Langchain-Chatchat`，`0.2.0` 发布，使用 `fastchat` 作为模型加载方案，支持更多的模型和数据库。 -+ `2023年10月`: `Langchain-Chatchat 0.2.5` 发布，推出 Agent 内容，开源项目在`Founder Park & Zhipu AI & Zilliz` 举办的黑客马拉松获得三等奖。 ++ `2023年10月`: `Langchain-Chatchat 0.2.5` 发布，推出 Agent 内容，开源项目在`Founder Park & Zhipu AI & Zilliz` + 举办的黑客马拉松获得三等奖。 + `2023年12月`: `Langchain-Chatchat` 开源项目获得超过 **20K** stars. -+ `2024年1月`: `LangChain 0.1.x` 推出，`Langchain-Chatchat 0.2.x` 停止更新和技术支持，全力研发具有更强应用性的 `Langchain-Chatchat 0.3.x`。 ++ `2024年1月`: `LangChain 0.1.x` 推出，`Langchain-Chatchat 0.2.x` 发布稳定版本`0.2.10` + 后将停止更新和技术支持，全力研发具有更强应用性的 `Langchain-Chatchat 0.3.x`。 + 🔥 让我们一起期待未来 Chatchat 的故事 ··· + --- + ## 联系我们 + ### Telegram + [![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white "langchain-chatglm")](https://t.me/+RjliQ3jnJ1YyN2E9) ### 项目交流群 + 二维码 🎉 Langchain-Chatchat 项目微信交流群，如果你也对本项目感兴趣，欢迎加入群聊参与讨论交流。 diff --git a/README_en.md b/README_en.md index 7765de83..dba6d3b7 100644 --- a/README_en.md +++ b/README_en.md @@ -7,6 +7,10 @@ A LLM application aims to implement knowledge and search engine based QA based on Langchain and open-source or remote LLM API. +⚠️`0.2.10` will be the last version of the `0.2.x` series. The `0.2.x` series will stop updating and technical support, +and strive to develop `Langchain-Chachat 0.3.x with stronger applicability. `. + + --- ## Table of Contents @@ -24,7 +28,8 @@ LLM API. ## Introduction 🤖️ A Q&A application based on local knowledge base implemented using the idea -of [langchain](https://github.com/hwchase17/langchain). The goal is to build a KBQA(Knowledge based Q&A) solution that +of [langchain](https://github.com/langchain-ai/langchain). The goal is to build a KBQA(Knowledge based Q&A) solution +that is friendly to Chinese scenarios and open source models and can run both offline and online. 💡 Inspired by [document.ai](https://github.com/GanymedeNil/document.ai) @@ -55,8 +60,7 @@ The main process analysis from the aspect of document process: 🚩 The training or fine-tuning are not involved in the project, but still, one always can improve performance by do these. -🌐 [AutoDL image](https://www.codewithgpu.com/i/chatchat-space/Langchain-Chatchat/Langchain-Chatchat) is supported, and in v13 the codes are update -to v0.2.9. +🌐 [AutoDL image](https://www.codewithgpu.com/i/chatchat-space/Langchain-Chatchat/Langchain-Chatchat) is supported, and in v13 the codes are update to v0.2.9. 🐳 [Docker image](registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.7) is supported to 0.2.7 @@ -169,8 +173,10 @@ please refer to the [Wiki](https://github.com/chatchat-space/Langchain-Chatchat/ + `October 2023`: `Langchain-Chachat 0.2.5` was released, Agent content was launched, and the open source project won the third prize in the hackathon held by `Founder Park & Zhipu AI & Zilliz`. + `December 2023`: `Langchain-Chachat` open source project received more than **20K** stars. -+ `January 2024`: `LangChain 0.1.x` is launched, `Langchain-Chatchat 0.2.x` will stop updating and technical support, - and all efforts will be made to develop `Langchain-Chatchat 0.3.x` with stronger applicability. ++ `January 2024`: `LangChain 0.1.x` is launched, `Langchain-Chachat 0.2.x` is released. After the stable + version `0.2.10` is released, updates and technical support will be stopped, and all efforts will be made to + develop `Langchain with stronger applicability -Chat 0.3.x`. + + 🔥 Let’s look forward to the future Chatchat stories together···