11![ ] ( img/logo-long-chatchat-trans-v2.png )
22
3- ** 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.
3+ [ ![ Telegram] ( https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white " langchain-chatglm ")] ( https://t.me/+RjliQ3jnJ1YyN2E9 )
4+
5+ 🌍 [ 中文文档] ( README.md )
6+
7+ 📃 ** 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.
48
59## Content
610
7- * Introduction
8- * Change Log
9- * Docker Deployment
10- * Deployment
11-
12- * Enviroment Preresiquisite
13- * Preparing Depolyment Enviroment
14- * Downloading model to local disk(for offline deployment only)
15- * Setting Configuration
16- * Knowledge Base Migration
17- * Luanching API Service or WebUI with One Command
18- * Luanching API Service or WebUI step-by-step
19- * FAQ
20- * Roadmap
21- * Wechat Group
11+ * [ Introduction] ( README_en.md#Introduction )
12+ * [ Change Log] ( README_en.md#Change-Log )
13+ * [ Supported Models] ( README_en.md#Supported-Models )
14+ * [ Docker Deployment] ( README_en.md#Docker-Deployment )
15+ * [ Development] ( README_en.md#Development )
16+ * [ Environment Prerequisite] ( README_en.md#Environment-Prerequisite )
17+ * [ Preparing Deployment Environment] ( README_en.md#1.-Preparing-Deployment-Environment )
18+ * [ Downloading model to local disk] ( README_en.md#2.-Downloading-model-to-local-disk )
19+ * [ Setting Configuration] ( README_en.md#3.-Setting-Configuration )
20+ * [ Knowledge Base Migration] ( README_en.md#4.-Knowledge-Base-Migration )
21+ * [ Launching API Service or WebUI] ( README_en.md#5.-Launching-API-Service-or-WebUI-with-One-Command )
22+ * [ FAQ] ( README_en.md#FAQ )
23+ * [ Roadmap] ( README_en.md#Roadmap )
2224
2325---
2426
@@ -139,7 +141,7 @@ Following models are tested by developers with Embedding class of [HuggingFace](
139141
140142---
141143
142- ## Docker image
144+ ## Docker Deployment
143145
144146🐳 Docker image path: ` registry.cn-beijing.aliyuncs.com/chatchat/chatchat:0.2.0) `
145147
@@ -156,13 +158,13 @@ docker run -d --gpus all -p 80:8501 registry.cn-beijing.aliyuncs.com/chatchat/ch
156158
157159---
158160
159- ## Deployment
161+ ## Development
160162
161- ### Enviroment Preresiquisite
163+ ### Environment Prerequisite
162164
163165The project is tested under Python3.8-python 3.10, CUDA 11.0-CUDA11.7, Windows, macOS of ARM architecture, and Linux platform.
164166
165- ### 1. Preparing Depolyment Enviroment
167+ ### 1. Preparing Deployment Environment
166168
167169Please refer to [ install.md] ( docs/INSTALL.md )
168170
@@ -224,7 +226,7 @@ The knowledge base information is stored in the database, please initialize the
224226 $ python init_database.py --recreate-vs
225227 ```
226228
227- ### 5. Luanching API Service or WebUI with One Command
229+ ### 5. Launching API Service or WebUI with One Command
228230
229231#### 5.1 Command
230232
@@ -308,10 +310,6 @@ The API, chat interface of WebUI, and knowledge management interface of WebUI ar
308310
309311![ img] ( img/webui_0915_1.png )
310312
311- ### 6 Luanching API Service or WebUI step-by-step
312-
313- ** The developers will depreciate step-by-step procudure in the future one or two version, feel free to ignore this part.**
314-
315313## FAQ
316314
317315Please refer to [ FAQ] ( docs/FAQ.md )
@@ -323,17 +321,17 @@ Please refer to [FAQ](docs/FAQ.md)
323321- [X] Langchain applications
324322
325323 - [X] Load local documents
326- - [X] Unstructed documents
324+ - [X] Unstructured documents
327325 - [X] .md
328326 - [X] .txt
329327 - [X] .docx
330- - [ ] Structed documents
328+ - [ ] Structured documents
331329 - [X] .csv
332330 - [ ] .xlsx
333- - [ ] TextSplliter and Retriever
334- - [ ] multipy TextSplitter
335- - [ ] ChineseTextSplitter
336- - [ ] Recontructed Context Retriever
331+ - [ ] TextSplitter and Retriever
332+ - [x] multiple TextSplitter
333+ - [x ] ChineseTextSplitter
334+ - [ ] Reconstructed Context Retriever
337335 - [ ] Webpage
338336 - [ ] SQL
339337 - [ ] Knowledge Database
@@ -342,22 +340,11 @@ Please refer to [FAQ](docs/FAQ.md)
342340 - [X] DuckDuckGo
343341 - [ ] Agent
344342- [X] LLM Models
345-
346343 - [X] [ FastChat] ( https://github.com/lm-sys/fastchat ) -based LLM Models
347344 - [ ] Mutiply Remote LLM API
348345- [X] Embedding Models
349-
350346 - [X] HuggingFace -based Embedding models
351347 - [ ] Mutiply Remote Embedding API
352- - [X] 基于 FastAPI -based API
348+ - [X] FastAPI-based API
353349- [X] Web UI
354-
355350 - [X] Streamlit -based Web UI
356-
357- ---
358-
359- ## WeChat Group QR Code
360-
361- <img src =" img/qr_code_59.jpg " alt =" 二维码 " width =" 300 " height =" 300 " />
362-
363- ** WeChat Group**
0 commit comments