weiweiw
/
Langchain-Chatchat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README.md and README_en.md

This commit is contained in:
imClumsyPanda 2023-09-15 14:18:35 +08:00
parent b2d86bf3f8
commit 456229c13f
2 changed files with 35 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,6 +1,10 @@
![](img/logo-long-chatchat-trans-v2.png) ![](img/logo-long-chatchat-trans-v2.png)
**LangChain-Chatchat** (原 Langchain-ChatGLM): 基于 Langchain 与 ChatGLM 等大语言模型的本地知识库问答应用实现。 [![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white "langchain-chatglm")](https://t.me/+RjliQ3jnJ1YyN2E9)
🌍 [READ THIS IN ENGLISH](README_en.md)
📃 **LangChain-Chatchat** (原 Langchain-ChatGLM): 基于 Langchain 与 ChatGLM 等大语言模型的本地知识库问答应用实现。
## 目录 ## 目录

73
README_en.md
View File

@ -1,24 +1,26 @@
![](img/logo-long-chatchat-trans-v2.png) ![](img/logo-long-chatchat-trans-v2.png)
**LangChain-Chatchat** (former Langchain-ChatGLM): A LLM application aims to implement knowledge- and search engineer- based QA based on Langchain and open-source or remote LLM api. [![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white "langchain-chatglm")](https://t.me/+RjliQ3jnJ1YyN2E9)
🌍 [中文文档](README.md)
📃 **LangChain-Chatchat** (formerly Langchain-ChatGLM): A LLM application aims to implement knowledge and search engine based QA based on Langchain and open-source or remote LLM API.
## Content ## Content
* Introduction * [Introduction](README_en.md#Introduction)
* Change Log * [Change Log](README_en.md#Change-Log)
* Docker Deployment * [Supported Models](README_en.md#Supported-Models)
* Deployment * [Docker Deployment](README_en.md#Docker-Deployment)
* [Development](README_en.md#Development)
* Enviroment Preresiquisite * [Environment Prerequisite](README_en.md#Environment-Prerequisite)
* Preparing Depolyment Enviroment * [Preparing Deployment Environment](README_en.md#1.-Preparing-Deployment-Environment)
* Downloading model to local disk(for offline deployment only) * [Downloading model to local disk](README_en.md#2.-Downloading-model-to-local-disk)
* Setting Configuration * [Setting Configuration](README_en.md#3.-Setting-Configuration)
* Knowledge Base Migration * [Knowledge Base Migration](README_en.md#4.-Knowledge-Base-Migration)
* Luanching API Service or WebUI with One Command * [Launching API Service or WebUI](README_en.md#5.-Launching-API-Service-or-WebUI-with-One-Command)
* Luanching API Service or WebUI step-by-step * [FAQ](README_en.md#FAQ)
* FAQ * [Roadmap](README_en.md#Roadmap)
* Roadmap
* Wechat Group
--- ---
@ -139,7 +141,7 @@ Following models are tested by developers with Embedding class of [HuggingFace](
--- ---
## Docker image ## Docker Deployment
🐳 Docker image path: `registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.0)` 🐳 Docker image path: `registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.0)`
@ -156,13 +158,13 @@ docker run -d --gpus all -p 80:8501 registry.cn-beijing.aliyuncs.com/chatchat/ch
--- ---
## Deployment ## Development
### Enviroment Preresiquisite ### Environment Prerequisite
The project is tested under Python3.8-python 3.10, CUDA 11.0-CUDA11.7, Windows, macOS of ARM architecture, and Linux platform. The project is tested under Python3.8-python 3.10, CUDA 11.0-CUDA11.7, Windows, macOS of ARM architecture, and Linux platform.
### 1. Preparing Depolyment Enviroment ### 1. Preparing Deployment Environment
Please refer to [install.md](docs/INSTALL.md) Please refer to [install.md](docs/INSTALL.md)
@ -224,7 +226,7 @@ The knowledge base information is stored in the database, please initialize the
$ python init_database.py --recreate-vs $ python init_database.py --recreate-vs
``` ```
### 5. Luanching API Service or WebUI with One Command ### 5. Launching API Service or WebUI with One Command
#### 5.1 Command #### 5.1 Command
@ -308,10 +310,6 @@ The API, chat interface of WebUI, and knowledge management interface of WebUI ar
![img](img/webui_0915_1.png) ![img](img/webui_0915_1.png)
### 6 Luanching API Service or WebUI step-by-step
**The developers will depreciate step-by-step procudure in the future one or two version, feel free to ignore this part.**
## FAQ ## FAQ
Please refer to [FAQ](docs/FAQ.md) Please refer to [FAQ](docs/FAQ.md)
@ -323,17 +321,17 @@ Please refer to [FAQ](docs/FAQ.md)
- [X] Langchain applications - [X] Langchain applications
- [X] Load local documents - [X] Load local documents
- [X] Unstructed documents - [X] Unstructured documents
- [X] .md - [X] .md
- [X] .txt - [X] .txt
- [X] .docx - [X] .docx
- [ ] Structed documents - [ ] Structured documents
- [X] .csv - [X] .csv
- [ ] .xlsx - [ ] .xlsx
- [ ] TextSplliter and Retriever - [ ] TextSplitter and Retriever
- [ ] multipy TextSplitter - [x] multiple TextSplitter
- [ ] ChineseTextSplitter - [x] ChineseTextSplitter
- [ ] Recontructed Context Retriever - [ ] Reconstructed Context Retriever
- [ ] Webpage - [ ] Webpage
- [ ] SQL - [ ] SQL
- [ ] Knowledge Database - [ ] Knowledge Database
@ -342,22 +340,11 @@ Please refer to [FAQ](docs/FAQ.md)
- [X] DuckDuckGo - [X] DuckDuckGo
- [ ] Agent - [ ] Agent
- [X] LLM Models - [X] LLM Models
- [X] [FastChat](https://github.com/lm-sys/fastchat) -based LLM Models - [X] [FastChat](https://github.com/lm-sys/fastchat) -based LLM Models
- [ ] Mutiply Remote LLM API - [ ] Mutiply Remote LLM API
- [X] Embedding Models - [X] Embedding Models
- [X] HuggingFace -based Embedding models - [X] HuggingFace -based Embedding models
- [ ] Mutiply Remote Embedding API - [ ] Mutiply Remote Embedding API
- [X] 基于 FastAPI -based API - [X] FastAPI-based API
- [X] Web UI - [X] Web UI
- [X] Streamlit -based Web UI - [X] Streamlit -based Web UI
---
## WeChat Group QR Code
<img src="img/qr_code_59.jpg" alt="二维码" width="300" height="300" />
**WeChat Group**