Skip to content

Commit

Permalink
doc:dbgpt-server docs
Browse files Browse the repository at this point in the history
1.update .env.template
2.update getting started
  • Loading branch information
Aries-ckt committed Jul 5, 2023
1 parent 469f500 commit 47595aa
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 42 deletions.
2 changes: 1 addition & 1 deletion .env.template
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ KNOWLEDGE_SEARCH_TOP_SIZE=5
#** DATABASE SETTINGS **#
#*******************************************************************#
LOCAL_DB_USER=root
LOCAL_DB_PASSWORD=aa123456
LOCAL_DB_PASSWORD=aa12345678
LOCAL_DB_HOST=127.0.0.1
LOCAL_DB_PORT=3306

Expand Down
16 changes: 7 additions & 9 deletions docs/getting_started/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ python -m spacy download zh_core_web_sm

Once the environment is installed, we have to create a new folder "models" in the DB-GPT project, and then we can put all the models downloaded from huggingface in this directory

make sure you have install git-lfs
Notice make sure you have install git-lfs
```
git clone https://huggingface.co/Tribbiani/vicuna-13b
git clone https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2
Expand Down Expand Up @@ -74,16 +74,14 @@ set .env configuration set your vector store type, eg:VECTOR_STORE_TYPE=Chroma,
```bash
$ python pilot/server/dbgpt_server.py
```
Open http://localhost:5000 with your browser to see the product.

3. Run new webui

If you want to access an external LLM service, you need to 1.set the variables LLM_MODEL=YOUR_MODEL_NAME MODEL_SERVER=YOUR_MODEL_SERVER(eg:http://localhost:5000) in the .env file.
2.execute dbgpt_server.py in light mode

```bash
$ cd datacenter
$ npm i
$ npm run dev
$ python pilot/server/dbgpt_server.py --light
```
Notice: make sure node.js is the latest version, learn more about db-gt webui,
read https://github.com/csunny/DB-GPT/tree/new-page-framework/datacenter

Open http://localhost:3000 with your browser to see the result.
If you want to learn about dbgpt-webui, read https://github.com/csunny/DB-GPT/tree/new-page-framework/datacenter

55 changes: 23 additions & 32 deletions docs/locales/zh_CN/LC_MESSAGES/getting_started/getting_started.po
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: DB-GPT 0.1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-06-30 17:16+0800\n"
"POT-Creation-Date: 2023-07-05 17:51+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 @@ -131,7 +131,8 @@ msgstr ""
"GPT项目中创建一个新文件夹\"models\",然后我们可以把从huggingface下载的所有模型放到这个目录下。"

#: ../../getting_started/getting_started.md:42 4dfb7d63fdf544f2bf9dd8663efa8d31
msgid "make sure you have install git-lfs"
#, fuzzy
msgid "Notice make sure you have install git-lfs"
msgstr "确保你已经安装了git-lfs"

#: ../../getting_started/getting_started.md:50 a52c137b8ef54b7ead41a2d8ff81d457
Expand Down Expand Up @@ -178,43 +179,33 @@ msgid ""
"set .env configuration set your vector store type, "
"eg:VECTOR_STORE_TYPE=Chroma, now we support Chroma and Milvus(version > "
"2.1)"
msgstr "在.env文件设置向量数据库环境变量,eg:VECTOR_STORE_TYPE=Chroma, 目前我们支持了 Chroma and Milvus(version >2.1) "
msgstr ""
"在.env文件设置向量数据库环境变量,eg:VECTOR_STORE_TYPE=Chroma, 目前我们支持了 Chroma and "
"Milvus(version >2.1) "

#: ../../getting_started/getting_started.md:72 cdb7ef30e8c9441293e8b3fd95d621ed
#, fuzzy
msgid "Run db-gpt server"
msgstr "运行模型服务"

#: ../../getting_started/getting_started.md:78 10fdefed00d34863819fffca48ca5bea
#: ../../getting_started/getting_started.md:77 e7bb3001d46b458aa0c522c4a7a8d45b
#, fuzzy
msgid "Run new webui"
msgstr "运行模型服务"
msgid "Open http://localhost:5000 with your browser to see the product."
msgstr "打开浏览器访问http://localhost:5000"

#: ../../getting_started/getting_started.md:86 60b48f6f0a7f43efa30c636a127860b6
#: ../../getting_started/getting_started.md:79 68c55e3ecfc642f2869a9917ec65904c
msgid ""
"Notice: make sure node.js is the latest version, learn more about db-gpt "
"webui, read https://github.com/csunny/DB-GPT/tree/new-page-"
"framework/datacenter"
msgstr "确保node.js是最新的版本,想知道更多请访问https://github.com/csunny/DB-GPT/tree/new-page-framework/datacenter,"

#: ../../getting_started/getting_started.md:89 e7bb3001d46b458aa0c522c4a7a8d45b
msgid "Open http://localhost:3000 with your browser to see the result."
msgstr "打开浏览器访问http://localhost:3000"

#~ msgid ""
#~ "Starting `llmserver.py` with the following "
#~ "command will result in a relatively "
#~ "stable Python service with multiple "
#~ "processes."
#~ msgstr ""

#~ msgid ""
#~ "Notice: the webserver need to connect"
#~ " llmserver, so you need change the"
#~ " .env file. change the MODEL_SERVER ="
#~ " \"http://127.0.0.1:8000\" to your address. "
#~ "It's very important."
#~ msgstr ""
#~ "注意: 在启动Webserver之前, 需要修改.env 文件中的MODEL_SERVER "
#~ "= \"http://127.0.0.1:8000\", 将地址设置为你的服务器地址。"
"If you want to access an external LLM service, you need to 1.set the "
"variables LLM_MODEL=YOUR_MODEL_NAME "
"MODEL_SERVER=YOUR_MODEL_SERVER(eg:http://localhost:5000) in the .env "
"file. 2.execute dbgpt_server.py in light mode"
msgstr "如果你想访问外部的大模型服务,1.需要在.env文件设置模型名和外部模型服务地址。2.使用light模式启动服务"

#: ../../getting_started/getting_started.md:86 474aea4023bb44dd970773b110bbf0ee
msgid ""
"If you want to learn about dbgpt-webui, read https://github.com/csunny"
"/DB-GPT/tree/new-page-framework/datacenter"
msgstr "如果你想了解DB-GPT前端服务,访问https://github.com/csunny"
"/DB-GPT/tree/new-page-framework/datacenter"


0 comments on commit 47595aa

Please sign in to comment.