From 2127035a00a1374e10825466e6547573d9e53523 Mon Sep 17 00:00:00 2001 From: xudafeng Date: Sun, 14 May 2023 23:00:18 +0800 Subject: [PATCH] docs: update readme --- README.md | 99 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 52 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index e06a10cb5..02e5c060e 100644 --- a/README.md +++ b/README.md @@ -21,78 +21,83 @@

-[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. - +DB-GPT 基于[FastChat](https://github.com/lm-sys/FastChat) 构建大模型运行环境，并提供 vicuna 作为基础的大语言模型。此外，我们通过 langchain 和 llama-index 提供私域知识库问答能力。 ## 效果演示 -Run on an RTX 4090 GPU (The origin mov not sped up!, [YouTube地址](https://www.youtube.com/watch?v=1PWI6F89LPo)) -- 运行演示 +示例通过 RTX 4090 GPU 演示，[YouTube 地址](https://www.youtube.com/watch?v=1PWI6F89LPo) +### 运行环境演示 -![](https://github.com/csunny/DB-GPT/blob/main/asserts/演示.gif) +

+ +

+### SQL 生成 -- SQL生成示例 -首先选择对应的数据库, 然后模型即可根据对应的数据库Schema信息生成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 +## 部署 + +### 1. 安装 Python 依赖的模块。 + +```bash +$ python>=3.9 +$ pip install -r requirements.txt ``` -2. MySQL Install +或者直接使用 conda 环境 -In this project examples, we connect mysql and run SQL-Generate. so you need install mysql local for test. recommand docker +```bash +$ conda env create -f environment.yml ``` -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. 基础模型下载 +### 2. 安装 MySQL + +本项目依赖一个本地的 MySQL 数据库服务，你需要本地安装，推荐直接使用 Docker 安装。 + +```bash +$ docker run --name=mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=aa12345678 -dit mysql:latest +``` + +### 3. 运行大模型 + 关于基础模型, 可以根据[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 +```bash +$ cd pilot/server +$ python vicuna_server.py ``` -3. Run gradio webui -``` -python webserver.py +运行 gradio webui + +```bash +$ python webserver.py ``` -4. 基于阿里云部署指南 -[阿里云部署指南](https://open.oceanbase.com/blog/3278046208) - -总的来说，它是一个用于数据库的复杂且创新的AI工具。如果您对如何在工作中使用或实施DB-GPT有任何具体问题，请联系我, 我会尽力提供帮助, 同时也欢迎大家参与到项目建设中, 做一些有趣的事情。 - - +可以通过阿里云部署大模型，请参考[阿里云部署指南](https://open.oceanbase.com/blog/3278046208)。 ## 感谢 @@ -106,7 +111,7 @@ python webserver.py ## Contributors -|[
csunny](https://github.com/csunny)
|[
xudafeng](https://github.com/xudafeng)
| +|[
csunny](https://github.com/csunny)
| | :---: | :---: |