diff --git a/README.en.md b/README.en.md new file mode 100644 index 000000000..b2e4c5d6f --- /dev/null +++ b/README.en.md @@ -0,0 +1,97 @@ +# DB-GPT + +--- + +A Open Database-GPT Experiment, interact your data and environment using the local GPT, no data leaks, 100% privately, 100% security. + +![GitHub Repo stars](https://img.shields.io/github/stars/csunny/db-gpt?style=social) + +一个数据库相关的GPT实验项目, 模型与数据全部本地化部署, 绝对保障数据的隐私安全。 同时此GPT项目可以直接本地部署连接到私有数据库, 进行私有数据处理。 + +[DB-GPT](https://github.com/csunny/DB-GPT) 是一个实验性的开源应用，它基于[FastChat](https://github.com/lm-sys/FastChat)，并使用[vicuna-13b](https://huggingface.co/Tribbiani/vicuna-13b)作为基础模型。此外，此程序结合了[langchain](https://github.com/hwchase17/langchain)和[llama-index](https://github.com/jerryjliu/llama_index)基于现有知识库进行[In-Context Learning](https://arxiv.org/abs/2301.00234)来对其进行数据库相关知识的增强。它可以进行SQL生成、SQL诊断、数据库知识问答、数据处理等一系列的工作。 + + +## 项目方案 + + +[DB-GPT](https://github.com/csunny/DB-GPT) is an experimental open-source application that builds upon the [FastChat](https://github.com/lm-sys/FastChat) model and uses vicuna as its base model. Additionally, it looks like this application incorporates langchain and llama-index embedding knowledge to improve Database-QA capabilities. + +Overall, it appears to be a sophisticated and innovative tool for working with databases. If you have any specific questions about how to use or implement DB-GPT in your work, please let me know and I'll do my best to assist you. + + +## 运行效果演示 +Run on an RTX 4090 GPU (The origin mov not sped up!, [YouTube地址](https://www.youtube.com/watch?v=1PWI6F89LPo)) +- 运行演示 + +![](https://github.com/csunny/DB-GPT/blob/main/asserts/演示.gif) + + +- SQL生成示例 +首先选择对应的数据库, 然后模型即可根据对应的数据库Schema信息生成SQL + + + +The Generated SQL is runable. + + + +- 数据库QA示例 + + + +基于默认内置知识库QA + + + +# Dependencies +1. First you need to install python requirements. +``` +python>=3.9 +pip install -r requirements.txt +``` +or if you use conda envirenment, you can use this command +``` +cd DB-GPT +conda env create -f environment.yml +``` + +2. MySQL Install + +In this project examples, we connect mysql and run SQL-Generate. so you need install mysql local for test. recommand docker +``` +docker run --name=mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=aa12345678 -dit mysql:latest +``` +The password just for test, you can change this if necessary + +# Install +1. 基础模型下载 +关于基础模型, 可以根据[vicuna](https://github.com/lm-sys/FastChat/blob/main/README.md#model-weights)合成教程进行合成。 +如果此步有困难的同学，也可以直接使用[Hugging Face](https://huggingface.co/)上的模型进行替代. [替代模型](https://huggingface.co/Tribbiani/vicuna-7b) + +2. Run model server +``` +cd pilot/server +python vicuna_server.py +``` + +3. Run gradio webui +``` +python webserver.py +``` + +4. 基于阿里云部署指南 +[阿里云部署指南](https://open.oceanbase.com/blog/3278046208) + +# Featurs +- SQL-Generate +- Database-QA Based Knowledge +- SQL-diagnosis + +总的来说，它是一个用于数据库的复杂且创新的AI工具。如果您对如何在工作中使用或实施DB-GPT有任何具体问题，请联系我, 我会尽力提供帮助, 同时也欢迎大家参与到项目建设中, 做一些有趣的事情。 + + + +# Contribute +[Contribute](https://github.com/csunny/DB-GPT/blob/main/CONTRIBUTING) +# Licence +[MIT](https://github.com/csunny/DB-GPT/blob/main/LICENSE) diff --git a/README.md b/README.md index f7ea9fae1..d033c263c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,24 @@ # DB-GPT -A Open Database-GPT Experiment, interact your data and environment using the local GPT, no data leaks, 100% privately, 100% security. ![GitHub Repo stars](https://img.shields.io/github/stars/csunny/db-gpt?style=social) -一个数据库相关的GPT实验项目, 模型与数据全部本地化部署, 绝对保障数据的隐私安全。 同时此GPT项目可以直接本地部署连接到私有数据库, 进行私有数据处理。 +--- -[DB-GPT](https://github.com/csunny/DB-GPT) 是一个实验性的开源应用，它基于[FastChat](https://github.com/lm-sys/FastChat)，并使用[vicuna-13b](https://huggingface.co/Tribbiani/vicuna-13b)作为基础模型。此外，此程序结合了[langchain](https://github.com/hwchase17/langchain)和[llama-index](https://github.com/jerryjliu/llama_index)基于现有知识库进行[In-Context Learning](https://arxiv.org/abs/2301.00234)来对其进行数据库相关知识的增强。它可以进行SQL生成、SQL诊断、数据库知识问答、数据处理等一系列的工作。 +专注于数据库垂直领域的 GPT 项目，提供大模型与数据的本地化使用方案，保障数据的隐私安全，适用企业内和个人。 + +## 项目能力一览 + +- SQL 语言能力 + - SQL生成 + - SQL诊断 +- 私域问答与数据处理 + - 数据库知识问答 + - 数据处理 + +[DB-GPT](https://github.com/csunny/DB-GPT) 是一个实验性的开源应用，它基于[FastChat](https://github.com/lm-sys/FastChat)，并使用[vicuna-13b](https://huggingface.co/Tribbiani/vicuna-13b)作为基础模型。此外，此程序结合了[langchain](https://github.com/hwchase17/langchain)和[llama-index](https://github.com/jerryjliu/llama_index)基于现有知识库进行[In-Context Learning](https://arxiv.org/abs/2301.00234)来对其进行数据库相关知识的增强。 -## 项目方案 +## 架构方案 [DB-GPT](https://github.com/csunny/DB-GPT) is an experimental open-source application that builds upon the [FastChat](https://github.com/lm-sys/FastChat) model and uses vicuna as its base model. Additionally, it looks like this application incorporates langchain and llama-index embedding knowledge to improve Database-QA capabilities. @@ -17,6 +27,7 @@ Overall, it appears to be a sophisticated and innovative tool for working with d ## 运行效果演示 + Run on an RTX 4090 GPU (The origin mov not sped up!, [YouTube地址](https://www.youtube.com/watch?v=1PWI6F89LPo)) - 运行演示