From 6ee26216d278f33c8d58b76c31d36b670b3bba13 Mon Sep 17 00:00:00 2001 From: csunny Date: Mon, 10 Jul 2023 15:52:40 +0800 Subject: [PATCH 1/3] docs: add describe for images --- README.md | 9 ++++++++- README.zh.md | 8 ++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index def812ce8..57ccf4a51 100644 --- a/README.md +++ b/README.md @@ -41,33 +41,40 @@ https://github.com/csunny/DB-GPT/assets/13723926/55f31781-1d49-4757-b96e-7ef6d3d --> + +#### Chat with data, and figure charts. +

+#### Text2SQL, generate SQL from chat

+#### Chat with database meta information.

+#### Chat with data, and execute results.

+#### Knownledge space to manage docs.

+#### Chat with knowledge, such as txt、pdf、csv、words. etc

- ## Features Currently, we have released multiple key features, which are listed below to demonstrate our current capabilities: diff --git a/README.zh.md b/README.zh.md index 218de21ca..53115fb1d 100644 --- a/README.zh.md +++ b/README.zh.md @@ -61,27 +61,35 @@ DB-GPT 是一个开源的以数据库为基础的GPT实验项目，使用本地 https://github.com/csunny/DB-GPT/assets/13723926/55f31781-1d49-4757-b96e-7ef6d3dbcf80 +#### 根据自然语言对话生成分析图表

+ +#### 根据自然语言对话生成SQL

+#### 与数据库元数据信息进行对话, 生成准确SQL语句

+ +#### 与数据对话, 直接查看执行结果

+#### 知识库管理

+#### 根据知识库对话, 比如pdf、csv、txt、words等等.

From 4aad503189a16971a18f197b62bd6d87bc4b2e83 Mon Sep 17 00:00:00 2001 From: csunny Date: Mon, 10 Jul 2023 15:54:43 +0800 Subject: [PATCH 2/3] chores: news -> new features. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 57ccf4a51..9256b55d6 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ As large models are released and iterated upon, they are becoming increasingly i DB-GPT is an experimental open-source project that uses localized GPT large models to interact with your data and environment. With this solution, you can be assured that there is no risk of data leakage, and your data is 100% private and secure. -## News +## New Features - [2023/07/06]🔥🔥🔥Brand-new DB-GPT product with a brand-new web UI. [documents](https://db-gpt.readthedocs.io/en/latest/getting_started/getting_started.html) - [2023/06/25]🔥support chatglm2-6b model. [documents](https://db-gpt.readthedocs.io/en/latest/modules/llms.html) - [2023/06/14] support gpt4all model, which can run at M1/M2, or cpu machine. [documents](https://db-gpt.readthedocs.io/en/latest/modules/llms.html) From b3ce3906a58348b3ac20d424eac9165bd594fb27 Mon Sep 17 00:00:00 2001 From: csunny Date: Mon, 10 Jul 2023 16:16:56 +0800 Subject: [PATCH 3/3] docs: update readme demo info --- README.md | 27 +++++++++----------- README.zh.md | 70 +++++++++++++++++++++++++++------------------------- 2 files changed, 48 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 9256b55d6..9538418ca 100644 --- a/README.md +++ b/README.md @@ -16,20 +16,9 @@ ## What is DB-GPT? -As large models are released and iterated upon, they are becoming increasingly intelligent. However, in the process of using large models, we face significant challenges in data security and privacy. We need to ensure that our sensitive data and environments remain completely controlled and avoid any data privacy leaks or security risks. Based on this, we have launched the DB-GPT project to build a complete private large model solution for all database-based scenarios. This solution supports local deployment, allowing it to be applied not only in independent private environments but also to be independently deployed and isolated according to business modules, ensuring that the ability of large models is absolutely private, secure, and controllable. - DB-GPT is an experimental open-source project that uses localized GPT large models to interact with your data and environment. With this solution, you can be assured that there is no risk of data leakage, and your data is 100% private and secure. -## New Features -- [2023/07/06]🔥🔥🔥Brand-new DB-GPT product with a brand-new web UI. [documents](https://db-gpt.readthedocs.io/en/latest/getting_started/getting_started.html) -- [2023/06/25]🔥support chatglm2-6b model. [documents](https://db-gpt.readthedocs.io/en/latest/modules/llms.html) -- [2023/06/14] support gpt4all model, which can run at M1/M2, or cpu machine. [documents](https://db-gpt.readthedocs.io/en/latest/modules/llms.html) -- [2023/06/01]🔥 On the basis of the Vicuna-13B basic model, task chain calls are implemented through plugins. For example, the implementation of creating a database with a single sentence.[demo](./assets/auto_plugin.gif) -- [2023/06/01]🔥 QLoRA guanaco(7b, 13b, 33b) support. -- [2023/05/28] Learning from crawling data from the Internet [demo](./assets/dbgpt_demo.gif) -- [2023/05/21] Generate SQL and execute it automatically. [demo](./assets/chat-data.gif) -- [2023/05/15] Chat with documents. [demo](./assets/new_knownledge_en.gif) -- [2023/05/06] SQL generation and diagnosis. [demo](./assets/demo_en.gif) +[![Star History Chart](https://api.star-history.com/svg?repos=csunny/DB-GPT)](https://star-history.com/#csunny/DB-GPT) ## Demo @@ -73,7 +62,16 @@ https://github.com/csunny/DB-GPT/assets/13723926/55f31781-1d49-4757-b96e-7ef6d3d

- +## Releases +- [2023/07/06]🔥🔥🔥Brand-new DB-GPT product with a brand-new web UI. [documents](https://db-gpt.readthedocs.io/en/latest/getting_started/getting_started.html) +- [2023/06/25]🔥support chatglm2-6b model. [documents](https://db-gpt.readthedocs.io/en/latest/modules/llms.html) +- [2023/06/14] support gpt4all model, which can run at M1/M2, or cpu machine. [documents](https://db-gpt.readthedocs.io/en/latest/modules/llms.html) +- [2023/06/01]🔥 On the basis of the Vicuna-13B basic model, task chain calls are implemented through plugins. For example, the implementation of creating a database with a single sentence.[demo](./assets/auto_plugin.gif) +- [2023/06/01]🔥 QLoRA guanaco(7b, 13b, 33b) support. +- [2023/05/28] Learning from crawling data from the Internet [demo](./assets/dbgpt_demo.gif) +- [2023/05/21] Generate SQL and execute it automatically. [demo](./assets/chat-data.gif) +- [2023/05/15] Chat with documents. [demo](./assets/new_knownledge_en.gif) +- [2023/05/06] SQL generation and diagnosis. [demo](./assets/demo_en.gif) ## Features @@ -102,7 +100,6 @@ Currently, we have released multiple key features, which are listed below to dem DB-GPT creates a vast model operating system using [FastChat](https://github.com/lm-sys/FastChat) and offers a large language model powered by [Vicuna](https://huggingface.co/Tribbiani/vicuna-7b). In addition, we provide private domain knowledge base question-answering capability. Furthermore, we also provide support for additional plugins, and our design natively supports the Auto-GPT plugin.Our vision is to make it easier and more convenient to build applications around databases and llm. - Is the architecture of the entire DB-GPT shown in the following figure:

@@ -166,5 +163,5 @@ The MIT License (MIT) ## Contact Information We are working on building a community, if you have any ideas about building the community, feel free to contact us. [Discord](https://discord.gg/4BNdxm5d) -[![Star History Chart](https://api.star-history.com/svg?repos=csunny/DB-GPT)](https://star-history.com/#csunny/DB-GPT) + diff --git a/README.zh.md b/README.zh.md index 53115fb1d..0bc8e75a4 100644 --- a/README.zh.md +++ b/README.zh.md @@ -19,41 +19,12 @@ DB-GPT 是一个开源的以数据库为基础的GPT实验项目，使用本地化的GPT大模型与您的数据和环境进行交互，无数据泄露风险，100% 私密 +[![Star History Chart](https://api.star-history.com/svg?repos=csunny/DB-GPT)](https://star-history.com/#csunny/DB-GPT) + + [DB-GPT视频介绍](https://www.bilibili.com/video/BV1SM4y1a7Nj/?buvid=551b023900b290f9497610b2155a2668&is_story_h5=false&mid=%2BVyE%2Fwau5woPcUKieCWS0A%3D%3D&p=1&plat_id=116&share_from=ugc&share_medium=iphone&share_plat=ios&share_session_id=5D08B533-82A4-4D40-9615-7826065B4574&share_source=GENERIC&share_tag=s_i×tamp=1686307943&unique_k=bhO3lgQ&up_id=31375446) -## 最新发布 -- [2023/07/06]🔥🔥🔥 全新的DB-GPT产品。 [使用文档](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/getting_started/getting_started.html) -- [2023/06/25]🔥 支持ChatGLM2-6B模型。 [使用文档](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/modules/llms.html) -- [2023/06/14]🔥 支持gpt4all模型，可以在M1/M2 或者CPU机器上运行。 [使用文档](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/modules/llms.html) -- [2023/06/01]🔥 在Vicuna-13B基础模型的基础上，通过插件实现任务链调用。例如单句创建数据库的实现. -- [2023/06/01]🔥 QLoRA guanaco(原驼)支持, 支持4090运行33B -- [2023/05/28]🔥根据URL进行对话 [演示](./assets/chat_url_zh.gif) -- [2023/05/21] SQL生成与自动执行. [演示](./assets/auto_sql.gif) -- [2023/05/15] 知识库对话 [演示](./assets/new_knownledge.gif) -- [2023/05/06] SQL生成与诊断 [演示](./assets/演示.gif) - -## 特性一览 - -目前我们已经发布了多种关键的特性，这里一一列举展示一下当前发布的能力。 -- SQL 语言能力 - - SQL生成 - - SQL诊断 -- 私域问答与数据处理 - - 知识库管理(目前支持 txt, pdf, md, html, doc, ppt, and url) - - 数据库知识问答 - - 数据处理 -- 插件模型 - - 支持自定义插件执行任务，原生支持Auto-GPT插件。如: - - SQL自动执行，获取查询结果 - - 自动爬取学习知识 -- 知识库统一向量存储/索引 - - 非结构化数据支持包括PDF、MarkDown、CSV、WebURL - -- 多模型支持 - - 支持多种大语言模型, 当前已支持Vicuna(7b,13b), ChatGLM-6b(int4, int8), guanaco(7b,13b,33b), Gorilla(7b,13b) - - TODO: codet5p, codegen2 - ## 效果演示 示例通过 RTX 4090 GPU 演示 @@ -94,6 +65,39 @@ https://github.com/csunny/DB-GPT/assets/13723926/55f31781-1d49-4757-b96e-7ef6d3d

+## 最新发布 +- [2023/07/06]🔥🔥🔥 全新的DB-GPT产品。 [使用文档](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/getting_started/getting_started.html) +- [2023/06/25]🔥 支持ChatGLM2-6B模型。 [使用文档](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/modules/llms.html) +- [2023/06/14]🔥 支持gpt4all模型，可以在M1/M2 或者CPU机器上运行。 [使用文档](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/modules/llms.html) +- [2023/06/01]🔥 在Vicuna-13B基础模型的基础上，通过插件实现任务链调用。例如单句创建数据库的实现. +- [2023/06/01]🔥 QLoRA guanaco(原驼)支持, 支持4090运行33B +- [2023/05/28]🔥根据URL进行对话 [演示](./assets/chat_url_zh.gif) +- [2023/05/21] SQL生成与自动执行. [演示](./assets/auto_sql.gif) +- [2023/05/15] 知识库对话 [演示](./assets/new_knownledge.gif) +- [2023/05/06] SQL生成与诊断 [演示](./assets/演示.gif) + +## 特性一览 + +目前我们已经发布了多种关键的特性，这里一一列举展示一下当前发布的能力。 +- SQL 语言能力 + - SQL生成 + - SQL诊断 +- 私域问答与数据处理 + - 知识库管理(目前支持 txt, pdf, md, html, doc, ppt, and url) + - 数据库知识问答 + - 数据处理 +- 插件模型 + - 支持自定义插件执行任务，原生支持Auto-GPT插件。如: + - SQL自动执行，获取查询结果 + - 自动爬取学习知识 +- 知识库统一向量存储/索引 + - 非结构化数据支持包括PDF、MarkDown、CSV、WebURL + +- 多模型支持 + - 支持多种大语言模型, 当前已支持Vicuna(7b,13b), ChatGLM-6b(int4, int8), guanaco(7b,13b,33b), Gorilla(7b,13b) + - TODO: codet5p, codegen2 + + ## 架构方案 DB-GPT基于 [FastChat](https://github.com/lm-sys/FastChat) 构建大模型运行环境，并提供 vicuna 作为基础的大语言模型。此外，我们通过LangChain提供私域知识库问答能力。同时我们支持插件模式, 在设计上原生支持Auto-GPT插件。我们的愿景是让围绕数据库和LLM构建应用程序更加简便和便捷。 @@ -175,5 +179,3 @@ Run the Python interpreter and type the commands: The MIT License (MIT) -[![Star History Chart](https://api.star-history.com/svg?repos=csunny/DB-GPT)](https://star-history.com/#csunny/DB-GPT) -