Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update readme #774

Merged
merged 1 commit into from
Nov 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ Run on an RTX 4090 GPU.
![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)

[**Usage Tutorial**](https://db-gpt.readthedocs.io/en/latest/getting_started/install/deploy/deploy.html)
- [**Install**](https://db-gpt.readthedocs.io/en/latest/getting_started/install/deploy/deploy.html)
- [**Install Step by Step**](https://db-gpt.readthedocs.io/en/latest/getting_started/install/deploy/deploy.html)
- [**Install**](https://db-gpt.readthedocs.io/en/latest/getting_started/install/deploy.html)
- [**Install Step by Step**](https://db-gpt.readthedocs.io/en/latest/getting_started/install/deploy.html)
- [**Docker Install**](https://db-gpt.readthedocs.io/en/latest/getting_started/install/docker/docker.html)
- [**Docker Compose**](https://db-gpt.readthedocs.io/en/latest/getting_started/install/docker_compose/docker_compose.html)
- [**How to Use**](https://db-gpt.readthedocs.io/en/latest/getting_started/application/chatdb/chatdb.html)
Expand Down
6 changes: 3 additions & 3 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ DB-GPT 是一个开源的以数据库为基础的GPT实验项目,使用本地
![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)
![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)

[**教程**](https://db-gpt.readthedocs.io/en/latest/getting_started/install/deploy/deploy.html)
- [**安装**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/getting_started/install/deploy/deploy.html)
- [**Install Step by Step**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/getting_started/install/deploy/deploy.html)
[**教程**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh-cn/latest/getting_started/install/deploy.html)
- [**安装**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh-cn/latest/getting_started/install/deploy.html)
- [**Install Step by Step**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh-cn/latest/getting_started/install/deploy.html)
- [**Docker安装**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/getting_started/install/docker/docker.html)
- [**Docker Compose安装**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/getting_started/install/docker_compose/docker_compose.html)
- [**产品使用手册**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/getting_started/application/chatdb/chatdb.html)
Expand Down
2 changes: 2 additions & 0 deletions docs/getting_started/install/deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,8 @@ If you are low hardware requirements you can install DB-GPT by Using third-part
or
git clone https://huggingface.co/moka-ai/m3e-large

Now DB-GPT support LLM REST API TYPE:

.. note::

* OpenAI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: DB-GPT 👏👏 0.3.5\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-11-03 15:25+0800\n"
"POT-Creation-Date: 2023-11-03 15:33+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: zh_CN\n"
Expand Down Expand Up @@ -38,55 +38,67 @@ msgstr ""
"plugins demonstration](../../../../assets/chat_data/chat_data.jpg)"

#: ../../getting_started/application/chatdb/chatdb.md:3
#: ../../getting_started/application/chatdb/chatdb.md:27
#: ../../getting_started/application/chatdb/chatdb.md:31
#: ../../getting_started/application/chatdb/chatdb.md:35
#: ../../getting_started/application/chatdb/chatdb.md:50
#: ../../getting_started/application/chatdb/chatdb.md:55
#: ../../getting_started/application/chatdb/chatdb.md:61
#: ../../getting_started/application/chatdb/chatdb.md:26
#: ../../getting_started/application/chatdb/chatdb.md:30
#: ../../getting_started/application/chatdb/chatdb.md:34
#: ../../getting_started/application/chatdb/chatdb.md:49
#: ../../getting_started/application/chatdb/chatdb.md:54
#: ../../getting_started/application/chatdb/chatdb.md:60
#: 1467691a6012498795a94a14f7eba307 32315140835948c58e1721c7e2fa88a9
#: 3b8e3c3396ff47348105a6dec9e755ba 6b116d2bac2d43faa4cbcbd0c4151344
#: a314854e9be945dd88ad241bfa340870 d94d5f0e608f4399a0e10d593f0ab1da
#: e0ca6ec1841040bc828ce2ef29c387b6
#: 3b8e3c3396ff47348105a6dec9e755ba a314854e9be945dd88ad241bfa340870
#: d94d5f0e608f4399a0e10d593f0ab1da e0ca6ec1841040bc828ce2ef29c387b6
msgid "db plugins demonstration"
msgstr "db plugins demonstration"

#: ../../getting_started/application/chatdb/chatdb.md:8
#: ../../getting_started/application/chatdb/chatdb.md:7
#: 67cb0954cfa54e629b75cf9a241f6b9d
msgid ""
"The LLM (Language Model) suitable for the ChatData scene is * "
"chatgpt3.5. * chatgpt4. * Vicuna-v1.5."
msgstr "ChatData场景适用的LLM * "
"chatgpt3.5. * chatgpt4. * Vicuna-v1.5."
#, fuzzy
msgid "The LLM (Language Model) suitable for the ChatData scene is"
msgstr "ChatData场景适用的LLM * chatgpt3.5. * chatgpt4. * Vicuna-v1.5."

#: ../../getting_started/application/chatdb/chatdb.md:8
#: c973e19574e2405a96eb003c64063bfc
msgid "chatgpt3.5."
msgstr ""

#: ../../getting_started/application/chatdb/chatdb.md:9
#: 649b2382378c416591db7038a269c33b
msgid "chatgpt4."
msgstr ""

#: ../../getting_started/application/chatdb/chatdb.md:14
#: ../../getting_started/application/chatdb/chatdb.md:10
#: fac49de88fe3409f818193b953714cb9
msgid "Vicuna-v1.5."
msgstr ""

#: ../../getting_started/application/chatdb/chatdb.md:13
#: 8bd004993a834b0797ebcb5b6a6b1a23
msgid "1.Choose Datasource"
msgstr "1.Choose Datasource"

#: ../../getting_started/application/chatdb/chatdb.md:16
#: ../../getting_started/application/chatdb/chatdb.md:15
#: 34abfdced7804b51a212c0e567ffda6b
msgid ""
"If you are using DB-GPT for the first time, you need to add a data source"
" and set the relevant connection information for the data source."
msgstr "如果你是第一次使用DB-GPT, 首先需要添加数据源,设置数据源的相关连接信息"

#: ../../getting_started/application/chatdb/chatdb.md:20
#: ../../getting_started/application/chatdb/chatdb.md:19
#: 3a8d16a8a32c4ac5affbd8093677b4f8
msgid "there are some example data in DB-GPT-NEW/DB-GPT/docker/examples"
msgstr "在DB-GPT-NEW/DB-GPT/docker/examples有数据示例"

#: ../../getting_started/application/chatdb/chatdb.md:22
#: ../../getting_started/application/chatdb/chatdb.md:21
#: 2c3333a2705648148f79623c220d90cd
msgid "you can execute sql script to generate data."
msgstr "你可以通过执行sql脚本生成测试数据"

#: ../../getting_started/application/chatdb/chatdb.md:25
#: ../../getting_started/application/chatdb/chatdb.md:24
#: 4994182137574d14a3eefb421ceccd8e
msgid "1.1 Datasource management"
msgstr "1.1 Datasource management"

#: ../../getting_started/application/chatdb/chatdb.md:27
#: ../../getting_started/application/chatdb/chatdb.md:26
#: 94680e1487d84092abc51a7da9bf1075
msgid ""
"![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
Expand All @@ -95,12 +107,12 @@ msgstr ""
"![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
"GPT/assets/13723926/7678f07e-9eee-40a9-b980-5b3978a0ed52)"

#: ../../getting_started/application/chatdb/chatdb.md:29
#: ../../getting_started/application/chatdb/chatdb.md:28
#: 236dbd6d6cb4467593bf30597ecb215c
msgid "1.2 Connection management"
msgstr "1.2 Connection管理"

#: ../../getting_started/application/chatdb/chatdb.md:31
#: ../../getting_started/application/chatdb/chatdb.md:30
#: 6611193e600c4452ac8a9769c6230590
msgid ""
"![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
Expand All @@ -109,12 +121,12 @@ msgstr ""
"![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
"GPT/assets/13723926/25b8f5a9-d322-459e-a8b2-bfe8cb42bdd6)"

#: ../../getting_started/application/chatdb/chatdb.md:33
#: ../../getting_started/application/chatdb/chatdb.md:32
#: 7cceb9703af54970bee4a50fb07d4509
msgid "1.3 Add Datasource"
msgstr "1.3 添加Datasource"

#: ../../getting_started/application/chatdb/chatdb.md:35
#: ../../getting_started/application/chatdb/chatdb.md:34
#: 83c9e18cb87b4f0d9b0ce5e68b7fea77
msgid ""
"![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
Expand All @@ -123,53 +135,53 @@ msgstr ""
"![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
"GPT/assets/13723926/19ce31a7-4061-4da8-a9cb-efca396cc085)"

#: ../../getting_started/application/chatdb/chatdb.md:38
#: ../../getting_started/application/chatdb/chatdb.md:37
#: 143fb04274cd486687c5766179f6103e
msgid "now DB-GPT support Datasource Type"
msgstr "DB-GPT支持数据源类型"

#: ../../getting_started/application/chatdb/chatdb.md:40
#: ../../getting_started/application/chatdb/chatdb.md:39
#: 8bcf83e66b2d4d858407fc2b21b8fe85
msgid "Mysql"
msgstr "Mysql"

#: ../../getting_started/application/chatdb/chatdb.md:41
#: ../../getting_started/application/chatdb/chatdb.md:40
#: cd74abd5d6f4410ca001a3de2685e768
msgid "Sqlite"
msgstr "Sqlite"

#: ../../getting_started/application/chatdb/chatdb.md:42
#: ../../getting_started/application/chatdb/chatdb.md:41
#: fc5e01baba43449f8c3eb9b4b36a0ed8
msgid "DuckDB"
msgstr "DuckDB"

#: ../../getting_started/application/chatdb/chatdb.md:43
#: ../../getting_started/application/chatdb/chatdb.md:42
#: 10b6fe2153cd4ceba949687a54c3a68c
msgid "Clickhouse"
msgstr "Clickhouse"

#: ../../getting_started/application/chatdb/chatdb.md:44
#: ../../getting_started/application/chatdb/chatdb.md:43
#: 9ce0a41784f041d39138a81099c386e9
#, fuzzy
msgid "Mssql"
msgstr "Mysql"

#: ../../getting_started/application/chatdb/chatdb.md:45
#: ../../getting_started/application/chatdb/chatdb.md:44
#: 4af6eb835e954e0d937e98b308fb512b
msgid "Spark"
msgstr "Spark"

#: ../../getting_started/application/chatdb/chatdb.md:48
#: ../../getting_started/application/chatdb/chatdb.md:47
#: 8aaa3a73090b4805b2dddf1cc355d83c
msgid "2.ChatData"
msgstr "2.ChatData"

#: ../../getting_started/application/chatdb/chatdb.md:49
#: ../../getting_started/application/chatdb/chatdb.md:48
#: a34c79c99bd34233ae92d3090ff0b877
msgid "Preview Mode"
msgstr "Preview Mode"

#: ../../getting_started/application/chatdb/chatdb.md:50
#: ../../getting_started/application/chatdb/chatdb.md:49
#: 39e31a2a01494d4191d415a2240e026d
#, fuzzy
msgid ""
Expand All @@ -182,12 +194,12 @@ msgstr ""
"设置数据源成功后就可以和数据库进行对话了。你可以让它帮你生成SQL,也可以和问它数据库元数据的相关信息。 ![db plugins "
"demonstration](../../../../assets/chat_data/chatdata_eg.png)"

#: ../../getting_started/application/chatdb/chatdb.md:54
#: ../../getting_started/application/chatdb/chatdb.md:53
#: 999c78e8b604493a8190b0e1258d0da4
msgid "Editor Mode"
msgstr "Editor Mode"

#: ../../getting_started/application/chatdb/chatdb.md:55
#: ../../getting_started/application/chatdb/chatdb.md:54
#: e4a61d1e62c743f8b13dbed92ec265ba
msgid ""
"In Editor Mode, you can edit your sql and execute it. ![db plugins "
Expand All @@ -198,12 +210,12 @@ msgstr ""
"/eosphoros-ai/DB-"
"GPT/assets/13723926/1a896dc1-7c0e-4354-8629-30357ffd8d7f)"

#: ../../getting_started/application/chatdb/chatdb.md:59
#: ../../getting_started/application/chatdb/chatdb.md:58
#: b3a0d94083524d249f97dd426e1e1f26
msgid "3.ChatDB"
msgstr "3.ChatDB"

#: ../../getting_started/application/chatdb/chatdb.md:61
#: ../../getting_started/application/chatdb/chatdb.md:60
#: 8f4bd453447f48019a597eb3e4a59875
msgid ""
"![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: DB-GPT 👏👏 0.3.6\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-11-03 15:25+0800\n"
"POT-Creation-Date: 2023-11-03 15:33+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: zh_CN\n"
Expand All @@ -20,7 +20,7 @@ msgstr ""
"Generated-By: Babel 2.12.1\n"

#: ../../getting_started/application/chatexcel/chatexcel.md:1
#: ../../getting_started/application/chatexcel/chatexcel.md:15
#: ../../getting_started/application/chatexcel/chatexcel.md:14
#: 5e9c1de21de240839a510b9e05afcba1 96556d6d1d734f67ab15e548c9fdce2f
msgid "ChatExcel"
msgstr ""
Expand All @@ -36,68 +36,74 @@ msgid ""
msgstr "使用自然语言进行Excel数据的分析处理"

#: ../../getting_started/application/chatexcel/chatexcel.md:3
#: ../../getting_started/application/chatexcel/chatexcel.md:19
#: ../../getting_started/application/chatexcel/chatexcel.md:23
#: ../../getting_started/application/chatexcel/chatexcel.md:27
#: 05b68001df5449869515898742ba2b3a 13c354703dfd4a8487d2c4e5bf4abd73
#: 286462d6d79b4189bcd9d17937a96233 5aac360c20ea4ad189539e28e5e1c70f
#: 7009abd113244cc5badb8e90837dc9af 7eb17d02534d4f77b7602f3756da0d5e
#: be04d49fc14641b8b0d17c1e9d02973b f5c1cfd0f77d4199a45988114174c67f
#: ../../getting_started/application/chatexcel/chatexcel.md:18
#: ../../getting_started/application/chatexcel/chatexcel.md:22
#: ../../getting_started/application/chatexcel/chatexcel.md:26
#: 286462d6d79b4189bcd9d17937a96233 7009abd113244cc5badb8e90837dc9af
#: 7eb17d02534d4f77b7602f3756da0d5e f5c1cfd0f77d4199a45988114174c67f
msgid "db plugins demonstration"
msgstr ""

#: ../../getting_started/application/chatexcel/chatexcel.md:7
#: ../../getting_started/application/chatexcel/chatexcel.md:6
#: 338f0b19314f4026b84a670d35056e6c
msgid ""
"The LLM (Language Model) suitable for the ChatExcel scene is * "
"chatgpt3.5. * chatgpt4."
msgstr "ChatExcel场景适用的LLM 是 scene is * "
"chatgpt3.5. * chatgpt4."
#, fuzzy
msgid "The LLM (Language Model) suitable for the ChatExcel scene is"
msgstr "ChatExcel场景适用的LLM 是 scene is * chatgpt3.5. * chatgpt4."

#: ../../getting_started/application/chatexcel/chatexcel.md:12
#: ../../getting_started/application/chatexcel/chatexcel.md:7
#: bc09e8af60b64a8fbeecedb927a5a854
msgid "chatgpt3.5."
msgstr ""

#: ../../getting_started/application/chatexcel/chatexcel.md:8
#: e840c31d671946c190e27e1b7dd28647
msgid "chatgpt4."
msgstr ""

#: ../../getting_started/application/chatexcel/chatexcel.md:11
#: 2a710e2650bb44ef9d4a1ee4b8225a35
msgid "1.Select And Upload Excel or CSV File"
msgstr ""

#: ../../getting_started/application/chatexcel/chatexcel.md:13
#: ../../getting_started/application/chatexcel/chatexcel.md:12
#: df48b1003f3640cfa621e416f0405e8d
msgid "Select your excel or csv file to upload and start the conversation."
msgstr "选择你的Excel或者CSV文件上传开始对话"

#: ../../getting_started/application/chatexcel/chatexcel.md:17
#: ../../getting_started/application/chatexcel/chatexcel.md:16
#: 7ef5d5ebb634406ea4b566bbf5e30fd7
msgid ""
"The ChatExcel function supports Excel and CSV format files, select the "
"corresponding file to use."
msgstr "ChatExcel功能支持Excel和CSV格式的文件,选择对应格式的文件开始使用"

#: ../../getting_started/application/chatexcel/chatexcel.md:19
#: ../../getting_started/application/chatexcel/chatexcel.md:18
#: 40c79b71820f44439b1f541db2be9dd9
msgid ""
"![db plugins "
"demonstration](../../../../assets/chat_excel/chat_excel_2.png) ![db "
"plugins demonstration](../../../../assets/chat_excel/chat_excel_3.png)"
msgstr ""

#: ../../getting_started/application/chatexcel/chatexcel.md:22
#: ../../getting_started/application/chatexcel/chatexcel.md:21
#: 0dd469b6f56a442485392346065e345d
msgid "2.Wait for Data Processing"
msgstr "等待数据处理"

#: ../../getting_started/application/chatexcel/chatexcel.md:23
#: ../../getting_started/application/chatexcel/chatexcel.md:22
#: 0e9213342664465187981d6fea41e7ba
msgid ""
"After the data is uploaded, it will first learn and process the data "
"structure and field meaning. ![db plugins "
"demonstration](../../../../assets/chat_excel/chat_excel_4.png)"
msgstr "等待数据上传完成,会自动进行数据结构的学习和处理"

#: ../../getting_started/application/chatexcel/chatexcel.md:26
#: ../../getting_started/application/chatexcel/chatexcel.md:25
#: dd2047d1199542f7abda4767b953cfac
msgid "3.Use Data Analysis Calculation"
msgstr "开始使用数据分析计算"

#: ../../getting_started/application/chatexcel/chatexcel.md:27
#: ../../getting_started/application/chatexcel/chatexcel.md:26
#: 4e168def205743c898586e99e34d3e18
msgid ""
"Now you can use natural language to analyze and query data in the dialog "
Expand Down
Loading