Skip to content

Commit 8d91f68

Browse files
docs: update studio doc (#52)
* update studio doc * update to 0.2.0
1 parent 490b22d commit 8d91f68

File tree

3 files changed

+41
-5
lines changed

3 files changed

+41
-5
lines changed

docs/docs/veadk-studio.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,56 @@ VeADK Studio是我们提供的一站式Agent开发平台,提供本地Agent优
66

77
## 前置准备
88

9+
首先安装如下依赖:
10+
11+
```bash
12+
# 评测功能
13+
pip install "veadk-python[eval]"
14+
15+
# prompt 优化
16+
pip install "veadk-python[cli]"
17+
```
18+
919
你需要在你的Agent项目中准备一个`agent.py`文件,导出`agent``short_term_memory`两个全局变量:
1020

1121
```python
12-
agent = ...
22+
from veadk import Agent
23+
from veadk.memory.short_term_memory import ShortTermMemory
24+
25+
agent = Agent(...)
26+
27+
short_term_memory = ShortTermMemory(...)
28+
```
1329

14-
short_term_memory = ...
30+
此外,还需要在你的`config.yaml`中配置如下变量:
31+
32+
```yaml
33+
# 基础模型运行
34+
model:
35+
agent:
36+
provider: openai
37+
name: doubao-1-5-pro-256k-250115
38+
api_base: https://ark.cn-beijing.volces.com/api/v3/
39+
api_key:
40+
judge:
41+
name: doubao-1-5-pro-256k-250115
42+
api_base: https://ark.cn-beijing.volces.com/api/v3/
43+
api_key:
44+
45+
volcengine:
46+
access_key:
47+
secret_key:
48+
49+
agent_pilot:
50+
api_key:
1551
```
1652
1753
## 启动
1854
1955
在你准备好的Agent项目目录下执行以下命令:
2056
2157
```bash
22-
veadk-studio
58+
veadk studio
2359
```
2460

2561
Studio将会自动加载你的`agent.py`文件,启动一个本地服务器。注意,服务地址与端口必须固定为`127.0.0.1:8000`

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "veadk-python"
3-
version = "0.1.0"
3+
version = "0.2.0"
44
description = "Volcengine agent development kit, integrations with Volcengine cloud services."
55
readme = "README.md"
66
requires-python = ">=3.10"

veadk/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
VERSION = "0.1.0"
15+
VERSION = "0.2.0"

0 commit comments

Comments
 (0)