Skip to content

Commit e7c8c3e

Browse files
chenliang15405chenliang15405
authored
docs: update readme (#2760)
1 parent 569770e commit e7c8c3e

File tree

6 files changed

+159
-137
lines changed

6 files changed

+159
-137
lines changed

‎README.ja.md‎

Lines changed: 47 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# DB-GPT: データベースとの対話を革新するプライベートLLM技術
1+
# <img src="./assets/LOGO_SMALL.png" alt="Logo" style="vertical-align: middle; height: 24px;" /> DB-GPT: データベースとの対話を革新するプライベートLLM技術
22

3-
<p align="left">
4-
<img src="./assets/LOGO.png" width="100%" />
3+
4+
<p style="text-align: left;">
5+
<img src="./assets/Twitter_LOGO.png" width="100%" />
56
</p>
67

7-
<div align="center">
8+
<div style="text-align: center;">
89
<p>
910
<a href="https://github.com/eosphoros-ai/DB-GPT">
1011
<img alt="stars" src="https://img.shields.io/github/stars/eosphoros-ai/db-gpt?style=social" />
@@ -21,18 +22,30 @@
2122
<a href="https://github.com/eosphoros-ai/DB-GPT/issues">
2223
<img alt="Open Issues" src="https://img.shields.io/github/issues-raw/eosphoros-ai/DB-GPT" />
2324
</a>
24-
<a href="https://discord.gg/7uQnPuveTY">
25-
<img alt="Discord" src="https://dcbadge.vercel.app/api/server/7uQnPuveTY?compact=true&style=flat" />
25+
<a href="https://x.com/DBGPT_AI">
26+
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/DBGPT_AI" />
27+
</a>
28+
<a href="https://medium.com/@dbgpt0506">
29+
<img alt="Medium Follow" src="https://badgen.net/badge/Medium/Dbgpt/orange?icon=medium" />
30+
</a>
31+
<a href="https://space.bilibili.com/3537113070963392">
32+
<img alt="Bilibili Space" src="https://img.shields.io/badge/Bilibili-DB--GPT-blue?style=plastic&logo=bilibili&link=https%3A%2F%2Fspace.bilibili.com%2F3537113070963392" />
2633
</a>
2734
<a href="https://join.slack.com/t/slack-inu2564/shared_invite/zt-29rcnyw2b-N~ubOD9kFc7b7MDOAM1otA">
2835
<img alt="Slack" src="https://badgen.net/badge/Slack/Join%20DB-GPT/0abd59?icon=slack" />
2936
</a>
37+
<br/>
3038
<a href="https://codespaces.new/eosphoros-ai/DB-GPT">
3139
<img alt="Open in GitHub Codespaces" src="https://github.com/codespaces/badge.svg" />
3240
</a>
3341
</p>
3442

35-
[**英語**](README.md) | [**中国語**](README.zh.md) | [**Discord**](https://discord.gg/7uQnPuveTY) | [**ドキュメント**](https://docs.dbgpt.site) | [**微信**](https://github.com/eosphoros-ai/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) | [**コミュニティ**](https://github.com/eosphoros-ai/community) | [**論文**](https://arxiv.org/pdf/2312.17449.pdf)
43+
[![英語](https://img.shields.io/badge/英語-gray?style=flat-square)](README.md)
44+
[![中国語](https://img.shields.io/badge/中国語-gray?style=flat-square)](README.zh.md)
45+
[![日本語](https://img.shields.io/badge/日本語-gray?style=flat-square)](README.ja.md)
46+
47+
[**ドキュメント**](http://docs.dbgpt.cn/docs/overview/) | [**チームに連絡します**](https://github.com/eosphoros-ai/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) | [**コミュニティ**](https://github.com/eosphoros-ai/community) | [**論文**](https://arxiv.org/pdf/2312.17449.pdf)
48+
3649

3750
</div>
3851

@@ -44,33 +57,7 @@
4457

4558
🚀 **データ3.0時代には、モデルとデータベースを基盤として、企業や開発者がより少ないコードで独自のアプリケーションを構築できます。**
4659

47-
### AIネイティブデータアプリ
48-
- 🔥🔥🔥 [V0.7.0 リリース | 重要なアップグレードのセット](http://docs.dbgpt.cn/blog/db-gpt-v070-release)
49-
- [サポート MCP Protocol](https://github.com/eosphoros-ai/DB-GPT/pull/2497)
50-
- [サポート DeepSeek R1](https://github.com/deepseek-ai/DeepSeek-R1)
51-
- [サポート QwQ-32B](https://huggingface.co/Qwen/QwQ-32B)
52-
- [基本モジュールをリファクタリングする]()
53-
- [dbgpt-app](./packages/dbgpt-app)
54-
- [dbgpt-core](./packages/dbgpt-core)
55-
- [dbgpt-serve](./packages/dbgpt-serve)
56-
- [dbgpt-client](./packages/dbgpt-client)
57-
- [dbgpt-accelerator](./packages/dbgpt-accelerator)
58-
- [dbgpt-ext](./packages/dbgpt-ext)
59-
60-
![Data-awels](https://github.com/eosphoros-ai/DB-GPT/assets/17919400/37d116fc-d9dd-4efa-b4df-9ab02b22541c)
61-
62-
![Data-Apps](https://github.com/eosphoros-ai/DB-GPT/assets/17919400/a7bf6d65-92d1-4f0e-aaf0-259ccdde22fd)
63-
64-
![dashboard-images](https://github.com/eosphoros-ai/DB-GPT/assets/17919400/1849a79a-f7fd-40cf-bc9c-b117a041dd6a)
65-
66-
## 目次
67-
- [紹介](#紹介)
68-
- [インストール](#インストール)
69-
- [特徴](#特徴)
70-
- [貢献](#貢献)
71-
- [連絡先](#連絡先情報)
72-
73-
## 紹介
60+
### 紹介
7461
DB-GPTのアーキテクチャは以下の図に示されています：
7562

7663
<p align="center">
@@ -91,7 +78,7 @@ DB-GPTのアーキテクチャは以下の図に示されています：
9178

9279
- **データソース**：DB-GPTのコア機能に生産ビジネスデータをシームレスに接続するために、さまざまなデータソースを統合します。
9380

94-
### サブモジュール
81+
#### サブモジュール
9582
- [DB-GPT-Hub](https://github.com/eosphoros-ai/DB-GPT-Hub) 大規模言語モデル（LLM）上での教師ありファインチューニング（SFT）を適用することにより、高性能なText-to-SQLワークフロー。
9683

9784
- [dbgpts](https://github.com/eosphoros-ai/dbgpts) dbgptsは、DB-GPT上で構築されたいくつかのデータアプリ、AWELオペレータ、AWELワークフローテンプレート、およびエージェントを含む公式リポジトリです。
@@ -118,6 +105,31 @@ DB-GPTのアーキテクチャは以下の図に示されています：
118105
- [DB-GPT-Plugins](https://github.com/eosphoros-ai/DB-GPT-Plugins) Auto-GPTプラグインを直接実行できるDB-GPTプラグイン
119106
- [GPT-Vis](https://github.com/eosphoros-ai/GPT-Vis) 可視化プロトコル
120107

108+
109+
### AIネイティブデータアプリ
110+
- 🔥🔥🔥 [V0.7.0 リリース | 重要なアップグレードのセット](http://docs.dbgpt.cn/blog/db-gpt-v070-release)
111+
- [サポート MCP Protocol](https://github.com/eosphoros-ai/DB-GPT/pull/2497)
112+
- [サポート DeepSeek R1](https://github.com/deepseek-ai/DeepSeek-R1)
113+
- [サポート QwQ-32B](https://huggingface.co/Qwen/QwQ-32B)
114+
- [基本モジュールをリファクタリングする]()
115+
- [dbgpt-app](./packages/dbgpt-app)
116+
- [dbgpt-core](./packages/dbgpt-core)
117+
- [dbgpt-serve](./packages/dbgpt-serve)
118+
- [dbgpt-client](./packages/dbgpt-client)
119+
- [dbgpt-accelerator](./packages/dbgpt-accelerator)
120+
- [dbgpt-ext](./packages/dbgpt-ext)
121+
122+
---
123+
124+
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
125+
126+
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
127+
128+
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
129+
130+
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
131+
132+
121133
## インストール
122134
![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
123135
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
@@ -232,9 +244,6 @@ DB-GPTのアーキテクチャは以下の図に示されています：
232244
## 画像
233245
🌐 [AutoDLイメージ](https://www.codewithgpu.com/i/eosphoros-ai/DB-GPT/dbgpt)
234246

235-
### 言語切り替え
236-
.env設定ファイルでLANGUAGEパラメータを変更して、異なる言語に切り替えることができます。デフォルトは英語です（中国語：zh、英語：en、他の言語は後で追加されます）。
237-
238247
## 貢献
239248

240249
- 新しい貢献のための詳細なガイドラインを確認するには、[貢献方法](https://github.com/eosphoros-ai/DB-GPT/blob/main/CONTRIBUTING.md)を参照してください。

‎README.md‎

Lines changed: 57 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# DB-GPT: AI Native Data App Development framework with AWEL(Agentic Workflow Expression Language) and Agents
1+
# <img src="./assets/LOGO_SMALL.png" alt="Logo" style="vertical-align: middle; height: 24px;" /> DB-GPT: AI Native Data App Development framework with AWEL and Agents
22

3-
<p align="left">
4-
<img src="./assets/LOGO.png" width="100%" />
3+
<p style="text-align: left;">
4+
<img src="./assets/Twitter_LOGO.png" width="100%" />
55
</p>
66

7-
<div align="center">
7+
<div style="text-align: center;">
88
<p>
99
<a href="https://github.com/eosphoros-ai/DB-GPT">
1010
<img alt="stars" src="https://img.shields.io/github/stars/eosphoros-ai/db-gpt?style=social" />
@@ -21,19 +21,30 @@
2121
<a href="https://github.com/eosphoros-ai/DB-GPT/issues">
2222
<img alt="Open Issues" src="https://img.shields.io/github/issues-raw/eosphoros-ai/DB-GPT" />
2323
</a>
24-
<a href="https://discord.gg/7uQnPuveTY">
25-
<img alt="Discord" src="https://dcbadge.vercel.app/api/server/7uQnPuveTY?compact=true&style=flat" />
24+
<a href="https://x.com/DBGPT_AI">
25+
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/DBGPT_AI" />
26+
</a>
27+
<a href="https://medium.com/@dbgpt0506">
28+
<img alt="Medium Follow" src="https://badgen.net/badge/Medium/Dbgpt/orange?icon=medium" />
29+
</a>
30+
<a href="https://space.bilibili.com/3537113070963392">
31+
<img alt="Bilibili Space" src="https://img.shields.io/badge/Bilibili-DB--GPT-blue?style=plastic&logo=bilibili&link=https%3A%2F%2Fspace.bilibili.com%2F3537113070963392" />
2632
</a>
2733
<a href="https://join.slack.com/t/slack-inu2564/shared_invite/zt-29rcnyw2b-N~ubOD9kFc7b7MDOAM1otA">
2834
<img alt="Slack" src="https://badgen.net/badge/Slack/Join%20DB-GPT/0abd59?icon=slack" />
2935
</a>
36+
<br/>
3037
<a href="https://codespaces.new/eosphoros-ai/DB-GPT">
3138
<img alt="Open in GitHub Codespaces" src="https://github.com/codespaces/badge.svg" />
3239
</a>
3340
</p>
3441

3542

36-
[**简体中文**](README.zh.md) | [**日本語**](README.ja.md) | [**Discord**](https://discord.gg/7uQnPuveTY) | [**Documents**](https://docs.dbgpt.site) | [**微信**](https://github.com/eosphoros-ai/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) | [**Community**](https://github.com/eosphoros-ai/community) | [**Paper**](https://arxiv.org/pdf/2312.17449.pdf)
43+
[![English](https://img.shields.io/badge/English-gray?style=flat-square)](README.md)
44+
[![简体中文](https://img.shields.io/badge/简体中文-gray?style=flat-square)](README.zh.md)
45+
[![日本語](https://img.shields.io/badge/日本語-gray?style=flat-square)](README.ja.md)
46+
47+
[**Documents**](http://docs.dbgpt.cn/docs/overview/) | [**Concat**](https://github.com/eosphoros-ai/DB-GPT/blob/main/README.zh.md#%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC) | [**Community**](https://github.com/eosphoros-ai/community) | [**Paper**](https://arxiv.org/pdf/2312.17449.pdf)
3748

3849
</div>
3950

@@ -45,40 +56,7 @@ The purpose is to build infrastructure in the field of large models, through the
4556

4657
🚀 **In the Data 3.0 era, based on models and databases, enterprises and developers can build their own bespoke applications with less code.**
4758

48-
### DISCKAIMER
49-
- [disckaimer](./DISCKAIMER.md)
50-
51-
### AI-Native Data App
52-
---
53-
- 🔥🔥🔥 [Released V0.7.0 | A set of significant upgrades](http://docs.dbgpt.cn/blog/db-gpt-v070-release)
54-
- [Support MCP Protocol](https://github.com/eosphoros-ai/DB-GPT/pull/2497)
55-
- [Support DeepSeek R1](https://github.com/deepseek-ai/DeepSeek-R1)
56-
- [Support QwQ-32B](https://huggingface.co/Qwen/QwQ-32B)
57-
- [Refactor the basic modules]()
58-
- [dbgpt-app](./packages/dbgpt-app)
59-
- [dbgpt-core](./packages/dbgpt-core)
60-
- [dbgpt-serve](./packages/dbgpt-serve)
61-
- [dbgpt-client](./packages/dbgpt-client)
62-
- [dbgpt-accelerator](./packages/dbgpt-accelerator)
63-
- [dbgpt-ext](./packages/dbgpt-ext)
64-
---
65-
66-
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
67-
68-
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
69-
70-
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
71-
72-
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
73-
74-
## Contents
75-
- [Introduction](#introduction)
76-
- [Install](#install)
77-
- [Features](#features)
78-
- [Contribution](#contribution)
79-
- [Contact](#contact-information)
80-
81-
## Introduction
59+
### Introduction
8260
The architecture of DB-GPT is shown in the following figure:
8361

8462
<p align="center">
@@ -99,7 +77,7 @@ The core capabilities include the following parts:
9977

10078
- **Data Sources**: Integrating various data sources to seamlessly connect production business data to the core capabilities of DB-GPT.
10179

102-
### SubModule
80+
#### SubModule
10381
- [DB-GPT-Hub](https://github.com/eosphoros-ai/DB-GPT-Hub) Text-to-SQL workflow with high performance by applying Supervised Fine-Tuning (SFT) on Large Language Models (LLMs).
10482

10583
- [dbgpts](https://github.com/eosphoros-ai/dbgpts) dbgpts is the official repository which contains some data apps、AWEL operators、AWEL workflow templates and agents which build upon DB-GPT.
@@ -123,7 +101,31 @@ The core capabilities include the following parts:
123101
- [DB-GPT-Plugins](https://github.com/eosphoros-ai/DB-GPT-Plugins) DB-GPT Plugins that can run Auto-GPT plugin directly
124102
- [GPT-Vis](https://github.com/eosphoros-ai/GPT-Vis) Visualization protocol
125103

126-
## Install
104+
### AI-Native Data App
105+
---
106+
- 🔥🔥🔥 [Released V0.7.0 | A set of significant upgrades](http://docs.dbgpt.cn/blog/db-gpt-v070-release)
107+
- [Support MCP Protocol](https://github.com/eosphoros-ai/DB-GPT/pull/2497)
108+
- [Support DeepSeek R1](https://github.com/deepseek-ai/DeepSeek-R1)
109+
- [Support QwQ-32B](https://huggingface.co/Qwen/QwQ-32B)
110+
- [Refactor the basic modules]()
111+
- [dbgpt-app](./packages/dbgpt-app)
112+
- [dbgpt-core](./packages/dbgpt-core)
113+
- [dbgpt-serve](./packages/dbgpt-serve)
114+
- [dbgpt-client](./packages/dbgpt-client)
115+
- [dbgpt-accelerator](./packages/dbgpt-accelerator)
116+
- [dbgpt-ext](./packages/dbgpt-ext)
117+
---
118+
119+
![app_chat_v0 6](https://github.com/user-attachments/assets/a2f0a875-df8c-4f0d-89a3-eed321c02113)
120+
121+
![app_manage_chat_data_v0 6](https://github.com/user-attachments/assets/c8cc85bb-e3c2-4fab-8fb9-7b4b469d0611)
122+
123+
![chat_dashboard_display_v0 6](https://github.com/user-attachments/assets/b15d6ebe-54c4-4527-a16d-02fbbaf20dc9)
124+
125+
![agent_prompt_awel_v0 6](https://github.com/user-attachments/assets/40761507-a1e1-49d4-b49a-3dd9a5ea41cc)
126+
127+
128+
## Installation / Quick Start
127129
![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
128130
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
129131
![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)
@@ -239,8 +241,6 @@ At present, we have introduced several key features to showcase our current capa
239241
🌐 [AutoDL Image](https://www.codewithgpu.com/i/eosphoros-ai/DB-GPT/dbgpt)
240242

241243

242-
### Language Switching
243-
In the .env configuration file, modify the LANGUAGE parameter to switch to different languages. The default is English (Chinese: zh, English: en, other languages to be added later).
244244

245245
## Contribution
246246

@@ -255,10 +255,13 @@ At present, we have introduced several key features to showcase our current capa
255255
## Licence
256256
The MIT License (MIT)
257257

258+
## DISCKAIMER
259+
- [disckaimer](./DISCKAIMER.md)
260+
258261
## Citation
259-
If you want to understand the overall architecture of DB-GPT, please cite <a href="https://arxiv.org/abs/2312.17449" target="_blank">paper</a> and <a href="https:// arxiv.org/abs/2404.10209" target="_blank">Paper</a>
262+
If you want to understand the overall architecture of DB-GPT, please cite <a href="https://arxiv.org/abs/2312.17449" target="_blank">Paper</a> and <a href="https://arxiv.org/abs/2404.10209" target="_blank">Paper</a>
260263

261-
If you want to learn about using DB-GPT for Agent development, please cite the <a href="https://arxiv.org/abs/2412.13520" target="_blank">paper</a>
264+
If you want to learn about using DB-GPT for Agent development, please cite the <a href="https://arxiv.org/abs/2412.13520" target="_blank">Paper</a>
262265
```bibtex
263266
@article{xue2023dbgpt,
264267
title={DB-GPT: Empowering Database Interactions with Private Large Language Models},
@@ -287,7 +290,12 @@ If you want to learn about using DB-GPT for Agent development, please cite the <
287290

288291

289292
## Contact Information
290-
We are working on building a community, if you have any ideas for building the community, feel free to contact us.
291-
[![](https://dcbadge.vercel.app/api/server/7uQnPuveTY?compact=true&style=flat)](https://discord.gg/7uQnPuveTY)
293+
Thanks to everyone who has contributed to DB-GPT! Your ideas, code, comments, and even sharing them at events and on social platforms can make DB-GPT better.
294+
We are working on building a community, if you have any ideas for building the community, feel free to contact us.
295+
296+
- [Github Issues](https://github.com/eosphoros-ai/DB-GPT/issues) ⭐️：For questions about using GB-DPT, see the CONTRIBUTING.
297+
- [Github Discussions](https://github.com/orgs/eosphoros-ai/discussions) ⭐️：Share your experience or unique apps.
298+
- [Twitter](https://x.com/DBGPT_AI) ⭐️：Please feel free to talk to us.
299+
292300

293301
[![Star History Chart](https://api.star-history.com/svg?repos=csunny/DB-GPT&type=Date)](https://star-history.com/#csunny/DB-GPT)

0 commit comments

Comments
 (0)