Skip to content

Commit 98e6447

Browse files
authored
chore: Update README_EN.md
1 parent 7a76f73 commit 98e6447

File tree

1 file changed

+10
-33
lines changed

1 file changed

+10
-33
lines changed

README_EN.md

Lines changed: 10 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center"><img src= "https://github.com/1Panel-dev/maxkb/assets/52996290/c0694996-0eed-40d8-b369-322bf2a380bf" alt="MaxKB" width="300" /></p>
2-
<h3 align="center">Knowledge base, question answering system, based on LLM large language models</h3>
2+
<h3 align="center">Top-Rated Retrieval-Augmented Generation (RAG) Chatbot.</h3>
33
<p align="center"><a href="https://trendshift.io/repositories/9113" target="_blank"><img src="https://trendshift.io/api/badge/repositories/9113" alt="1Panel-dev%2FMaxKB | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a></p>
44
<p align="center">
55
<a href="https://www.gnu.org/licenses/gpl-3.0.html#license-text"><img src="https://img.shields.io/github/license/1Panel-dev/maxkb?color=%231890FF" alt="License: GPL v3"></a>
@@ -10,12 +10,13 @@
1010
</p>
1111
<hr/>
1212

13-
MaxKB = Max Knowledge Base,It is an open source knowledge base question and answer system based on the LLM large language model. It is widely used in enterprise internal knowledge bases, customer services, academic research and education and other scenarios.
13+
MaxKB = Max Knowledge Base, it is a Chatbot based on Large Language Models (LLM) and Retrieval-Augmented Generation (RAG). MaxKB is widely applied in scenarios such as intelligent customer service, corporate internal knowledge bases, academic research, and education.
14+
15+
- **Ready-to-Use**: Supports direct uploading of documents / automatic crawling of online documents, with features for automatic text splitting, vectorization, and RAG (Retrieval-Augmented Generation). This effectively reduces hallucinations in large models, providing a superior smart Q&A interaction experience.
16+
- **Model-Agnostic**: Supports various large models, including private models (such as Llama 3, Qwen 2, etc.) and public models (like OpenAI, Claude, Gemini, etc.).
17+
- **Flexible Orchestration**: Equipped with a powerful workflow engine and function library, enabling the orchestration of AI processes to meet the needs of complex business scenarios.
18+
- **Seamless Integration**: Facilitates zero-coding rapid integration into third-party business systems, quickly equipping existing systems with intelligent Q&A capabilities to enhance user satisfaction.
1419

15-
- **Out-of-the-box**: Supports direct uploading of documents, automatic crawling of online documents, automatic text splitting, vectorization, RAG (retrieval enhancement generation), and a good interactive experience in intelligent question and answer;
16-
- **Model neutral**: Supports docking with various large language models, including local private large models (Llama 3/Qwen 2, etc.), domestic public large models (Tongyi Qianwen/Zhipu AI/Baidu Qianfan/Kimi/DeepSeek, etc.) and foreign public models Large models (OpenAI / Azure OpenAI / Gemini, etc.);
17-
- **Flexible Orchestration**: Built-in powerful workflow engine supports the orchestration of AI work processes to meet the needs of complex business scenarios;
18-
- **Seamless Embedding**: Supports rapid embedding into third-party business systems with zero coding, allowing existing systems to quickly have intelligent question and answer capabilities and improve user satisfaction
1920
## Quick start
2021

2122
```
@@ -25,20 +26,7 @@ docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/var/lib/po
2526
# pass: MaxKB@123..
2627
```
2728

28-
- You can also quickly deploy MaxKB + Ollama + Llama 3 through [1Panel App Store](https://apps.fit2cloud.com/1panel). A knowledge base question and answer system based on a local large model can be launched within 30 minutes and embedded into In third-party business systems;
29-
- If it is an intranet environment, it is recommended to use [offline installation package](https://community.fit2cloud.com/#/products/maxkb/downloads) for installation and deployment;
30-
- You can also experience it online: [DataEase Assistant](https://dataease.io/docs/v2/), which is an intelligent question and answer system based on MaxKB and has been embedded in DataEase products and online documents.;
31-
- MaxKB's product version is divided into community version and professional version. For details, please see: [MaxKB product version comparison](https://maxkb.cn/pricing.html).
32-
33-
If you have more questions, you can check the user manual or communicate with us through the forum. If you need to build a technical blog or knowledge base, it is recommended to use [Halo open source website building tool](https://github.com/halo-dev/halo/). You can experience Feizhiyun’s official [Technical Blog](https://blog.fit2cloud.com/) and [Knowledge Base](https://kb.fit2cloud.com) cases.
34-
- [Docs](https://maxkb.cn/docs/)
35-
- [Demo Vid](https://www.bilibili.com/video/BV1BE421M7YM/)
36-
- [Forum](https://bbs.fit2cloud.com/c/mk/11)
37-
- Technical exchange group
38-
39-
<image height="150px" width="150px" src="https://github.com/1Panel-dev/MaxKB/assets/52996290/a083d214-02be-4178-a1db-4f428124153a"/>
40-
41-
## UI Screenshots
29+
## Screenshots
4230

4331
<table style="border-collapse: collapse; border: 1px solid black;">
4432
<tr>
@@ -51,26 +39,15 @@ If you have more questions, you can check the user manual or communicate with us
5139
</tr>
5240
</table>
5341

54-
## Stack Used
42+
## Technical Stack
5543

56-
- Frontend:[Vue.js](https://cn.vuejs.org/)
44+
- Frontend:[Vue.js](https://vuejs.org/)
5745
- Backend:[Python / Django](https://www.djangoproject.com/)
5846
- LangChain:[LangChain](https://www.langchain.com/)
5947
- Vector DB:[PostgreSQL / pgvector](https://www.postgresql.org/)
60-
- Large models: various local private or public large models
61-
62-
## Other Projects From Feizhiyun
63-
64-
- [1Panel](https://github.com/1panel-dev/1panel/) - Modern, open source Linux server operation and maintenance management panel
65-
- [JumpServer](https://github.com/jumpserver/jumpserver/) - Popular open source bastion host
66-
- [DataEase](https://github.com/dataease/dataease/) - Open source data visualization analysis tools available to everyone
67-
- [MeterSphere](https://github.com/metersphere/metersphere/) - New generation of open-source test tools
68-
- [Halo](https://github.com/halo-dev/halo/) - Powerful and easy-to-use open source website building tool
6948

7049
## License
7150

72-
Copyright (c) 2014-2024 Feizhiyun FIT2CLOUD, All rights reserved.
73-
7451
Licensed under The GNU General Public License version 3 (GPLv3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
7552

7653
<https://www.gnu.org/licenses/gpl-3.0.html>

0 commit comments

Comments
 (0)