diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 000000000..de1c90cbd --- /dev/null +++ b/Dockerfile @@ -0,0 +1,21 @@ +FROM ubuntu:latest + +RUN apt-get update && apt-get install -y \ + git \ + python3 \ + pip + + +WORKDIR /app + +COPY . /app + +RUN pip install -r requirements.txt + +EXPOSE 3306 +EXPOSE 8000 + +CMD ["python", "pilot/server/vicuna_server.py"] +CMD ["python", "pilot/server/webserver.py"] + + diff --git a/README.md b/README.md index 845e1ffa4..4f3c2f5d0 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ # DB-GPT -A Open Database-GPT Experiment, A fully localized project. +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) 是一个实验性的开源应用，它基于[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. @@ -56,7 +56,7 @@ conda env create -f environment.yml 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=aa123456 -dit mysql:latest +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 @@ -76,6 +76,9 @@ python llmserver.py python webserver.py ``` +4. 基于阿里云部署指南 +[阿里云部署指南](https://open.oceanbase.com/blog/3278046208) + # Featurs - SQL-Generate - Database-QA Based Knowledge @@ -83,6 +86,8 @@ python webserver.py 总的来说，它是一个用于数据库的复杂且创新的AI工具。如果您对如何在工作中使用或实施DB-GPT有任何具体问题，请联系我, 我会尽力提供帮助, 同时也欢迎大家参与到项目建设中, 做一些有趣的事情。 + + # Contribute [Contribute](https://github.com/csunny/DB-GPT/blob/main/CONTRIBUTING) # Licence diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..e4d06db9f --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,19 @@ +# Security Policy + +## Supported Versions + +Use this section to tell people about which versions of your project are +currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| v0.0.4 | :no new features | +| v0.0.3 | :documents QA | +| v0.0.2 | :sql generator | +| v0.0.1 | :minst runable | + +## Reporting a Vulnerability + +Use this section to tell people how to report a vulnerability. + +we will build somethings small. diff --git a/asserts/DB-GPT.png b/asserts/DB-GPT.png new file mode 100644 index 000000000..1c9bee139 Binary files /dev/null and b/asserts/DB-GPT.png differ diff --git a/asserts/wechat.jpg b/asserts/wechat.jpg new file mode 100644 index 000000000..77ddbc89a Binary files /dev/null and b/asserts/wechat.jpg differ diff --git a/assets/DB-GPT.png b/assets/DB-GPT.png new file mode 100644 index 000000000..1c9bee139 Binary files /dev/null and b/assets/DB-GPT.png differ diff --git a/assets/DB_QA.png b/assets/DB_QA.png new file mode 100644 index 000000000..46bd327d0 Binary files /dev/null and b/assets/DB_QA.png differ diff --git a/assets/SQLGEN.png b/assets/SQLGEN.png new file mode 100644 index 000000000..cac479364 Binary files /dev/null and b/assets/SQLGEN.png differ diff --git a/assets/VectorDBQA.png b/assets/VectorDBQA.png new file mode 100644 index 000000000..05279002e Binary files /dev/null and b/assets/VectorDBQA.png differ diff --git a/assets/exeable.png b/assets/exeable.png new file mode 100644 index 000000000..47ee94f7d Binary files /dev/null and b/assets/exeable.png differ diff --git a/assets/pilot.png b/assets/pilot.png new file mode 100644 index 000000000..41bd01207 Binary files /dev/null and b/assets/pilot.png differ diff --git a/assets/readme.md b/assets/readme.md new file mode 100644 index 000000000..e69de29bb diff --git a/assets/sql_generate.png b/assets/sql_generate.png new file mode 100644 index 000000000..13fb44af0 Binary files /dev/null and b/assets/sql_generate.png differ diff --git a/assets/wechat.jpg b/assets/wechat.jpg new file mode 100644 index 000000000..77ddbc89a Binary files /dev/null and b/assets/wechat.jpg differ diff --git a/assets/演示.gif b/assets/演示.gif new file mode 100644 index 000000000..22bab31ab Binary files /dev/null and b/assets/演示.gif differ diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 000000000..fbf05f4c9 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,14 @@ +version: '3.9' + +services: + db-gpt: + build: + context: . + dockerfile: Dockerfile + image: db-gpt:latest + container_name: db-gpt + ports: + - 8000:8000 + - 3306:3306 + restart: unless-stopped + read-only: true