DB-GPT/README.md

DB-GPT

---

English Edition

专注于数据库垂直领域的 GPT 项目，提供大模型与数据的本地化使用方案，保障数据的隐私安全，适用企业内和个人。

特性一览

• SQL 语言能力
  • SQL生成
  • SQL诊断
• 私域问答与数据处理
  • 数据库知识问答
  • 数据处理

架构方案

DB-GPT 基于FastChat 构建大模型运行环境，并提供 vicuna 作为基础的大语言模型。此外，我们通过 langchain 和 llama-index 提供私域知识库问答能力。

效果演示

示例通过 RTX 4090 GPU 演示，YouTube 地址

运行环境演示

SQL 生成

首先选择对应的数据库, 然后模型即可根据对应的数据库 Schema 信息生成 SQL。

运行成功的效果如下面的演示：

数据库问答

基于默认内置知识库。

Dependencies

1. First you need to install python requirements.

python>=3.10
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

<p align="center">
  <img src="./assets/VectorDBQA.png" width="600px" />
</p>

## 部署

### 1. 安装 Python

```bash
$ python>=3.10
$ pip install -r requirements.txt

或者直接使用 conda 环境

$ conda env create -f environment.yml

2. 安装 MySQL

本项目依赖一个本地的 MySQL 数据库服务，你需要本地安装，推荐直接使用 Docker 安装。

$ docker run --name=mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=aa12345678 -dit mysql:latest

3. 运行大模型

关于基础模型, 可以根据vicuna合成教程进行合成。 如果此步有困难的同学，也可以直接使用Hugging Face上的模型进行替代. 替代模型

2. Run model server

cd pilot/server
python llmserver.py

运行 gradio webui

$ python webserver.py 

可以通过阿里云部署大模型，请参考阿里云部署指南。

感谢

项目取得的成果，需要感谢技术社区，尤其以下项目。

• FastChat 提供 chat 服务
• vicuna-13b 作为基础模型
• langchain 工具链
• llama-index 基于现有知识库进行In-Context Learning来对其进行数据库相关知识的增强。

Contributors

csunny	xudafeng

This project follows the git-contributor spec, auto updated at Sun May 14 2023 23:02:43 GMT+0800.

这是一个用于数据库的复杂且创新的工具，如有任何具体问题，请联系如下微信，我会尽力提供帮助，同时也欢迎参与到项目建设中。

Licence

The MIT License (MIT)