From b0e51c06387859d8fd78dbe345dd390b2721c9c4 Mon Sep 17 00:00:00 2001 From: "fangyaozheng@bytedance.com" Date: Thu, 14 Aug 2025 14:20:37 +0800 Subject: [PATCH 1/2] update studio doc --- docs/docs/veadk-studio.md | 42 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) diff --git a/docs/docs/veadk-studio.md b/docs/docs/veadk-studio.md index 315c6341..18bdf5dc 100644 --- a/docs/docs/veadk-studio.md +++ b/docs/docs/veadk-studio.md @@ -6,12 +6,48 @@ VeADK Studio是我们提供的一站式Agent开发平台,提供本地Agent优 ## 前置准备 +首先安装如下依赖: + +```bash +# 评测功能 +pip install "veadk-python[eval]" + +# prompt 优化 +pip install "veadk-python[cli]" +``` + 你需要在你的Agent项目中准备一个`agent.py`文件,导出`agent`和`short_term_memory`两个全局变量: ```python -agent = ... +from veadk import Agent +from veadk.memory.short_term_memory import ShortTermMemory + +agent = Agent(...) + +short_term_memory = ShortTermMemory(...) +``` -short_term_memory = ... +此外,还需要在你的`config.yaml`中配置如下变量: + +```yaml +# 基础模型运行 +model: + agent: + provider: openai + name: doubao-1-5-pro-256k-250115 + api_base: https://ark.cn-beijing.volces.com/api/v3/ + api_key: + judge: + name: doubao-1-5-pro-256k-250115 + api_base: https://ark.cn-beijing.volces.com/api/v3/ + api_key: + +volcengine: + access_key: + secret_key: + +agent_pilot: + api_key: ``` ## 启动 @@ -19,7 +55,7 @@ short_term_memory = ... 在你准备好的Agent项目目录下执行以下命令: ```bash -veadk-studio +veadk studio ``` Studio将会自动加载你的`agent.py`文件,启动一个本地服务器。注意,服务地址与端口必须固定为`127.0.0.1:8000`。 From 1600f57fc5bc9c2b2bae305e755049bbc6839639 Mon Sep 17 00:00:00 2001 From: "fangyaozheng@bytedance.com" Date: Thu, 14 Aug 2025 14:29:39 +0800 Subject: [PATCH 2/2] update to 0.2.0 --- pyproject.toml | 2 +- veadk/version.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 6d976580..32b3bc1b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "veadk-python" -version = "0.1.0" +version = "0.2.0" description = "Volcengine agent development kit, integrations with Volcengine cloud services." readme = "README.md" requires-python = ">=3.10" diff --git a/veadk/version.py b/veadk/version.py index 58878179..0fac5bed 100644 --- a/veadk/version.py +++ b/veadk/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -VERSION = "0.1.0" +VERSION = "0.2.0"