From 42a86f8f4870ea57f2c9b25054225bc38b458e99 Mon Sep 17 00:00:00 2001 From: aries_ckt <916701291@qq.com> Date: Wed, 5 Jul 2023 17:55:00 +0800 Subject: [PATCH] doc:dbgpt-server docs 1.update .env.template 2.update getting started --- .env.template | 2 +- docs/getting_started/getting_started.md | 16 +++--- .../getting_started/getting_started.po | 51 ++++++++----------- 3 files changed, 29 insertions(+), 40 deletions(-) diff --git a/.env.template b/.env.template index 88d780ef8..f3370e229 100644 --- a/.env.template +++ b/.env.template @@ -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 diff --git a/docs/getting_started/getting_started.md b/docs/getting_started/getting_started.md index 17907b72c..dcd5c9913 100644 --- a/docs/getting_started/getting_started.md +++ b/docs/getting_started/getting_started.md @@ -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 @@ -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. \ No newline at end of file +If you want to learn about dbgpt-webui, read https://github.com/csunny/DB-GPT/tree/new-page-framework/datacenter + diff --git a/docs/locales/zh_CN/LC_MESSAGES/getting_started/getting_started.po b/docs/locales/zh_CN/LC_MESSAGES/getting_started/getting_started.po index d4ead1cb1..b3946de69 100644 --- a/docs/locales/zh_CN/LC_MESSAGES/getting_started/getting_started.po +++ b/docs/locales/zh_CN/LC_MESSAGES/getting_started/getting_started.po @@ -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 \n" "Language: zh_CN\n" @@ -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 @@ -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," +"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:89 e7bb3001d46b458aa0c522c4a7a8d45b -msgid "Open http://localhost:3000 with your browser to see the result." -msgstr "打开浏览器访问http://localhost:3000" +#: ../../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" -#~ 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\", 将地址设置为你的服务器地址。"