prt66 commited on
Commit
da395eb
·
verified ·
1 Parent(s): 530296c

Upload TERMINAL_TASK_QUICKSTART_ZH.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. TERMINAL_TASK_QUICKSTART_ZH.md +321 -0
TERMINAL_TASK_QUICKSTART_ZH.md ADDED
@@ -0,0 +1,321 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Terminal 任务新用户运行指南
2
+
3
+ 本文面向拿到 `vibetrainbench/` 项目目录的新用户,说明如何准备 Terminal-Bench 2.1 的训练资源、启动评分服务,并运行一次由外层 Research Agent 驱动的 Terminal 训练任务。
4
+
5
+ > 本文中的项目根目录以 `VTB_REPO` 表示。所有命令均应在项目根目录执行。
6
+
7
+ ## 1. 运行内容与前提
8
+
9
+ 本项目会启动两部分程序:
10
+
11
+ - 外层 Research Agent:在训练容器中使用基座模型和本地 SFT 数据进行训练,并提交 `final_model/`。
12
+ - 评分服务:独立启动模型服务和 Terminal 基准任务容器,对已提交模型进行评测。
13
+
14
+ 运行前请确认:
15
+
16
+ - Linux 主机可访问 Docker daemon,且 Docker 能使用 NVIDIA GPU。
17
+ - 主机可访问所需的镜像、Python 工具、模型和 API 服务。
18
+ - 有足够的磁盘空间存放 Docker 镜像、模型、数据和训练结果;这些运行时内容默认写入 `vtb-env/`。
19
+ - 已准备好外层 Agent 的 API Key。本文示例使用 `claude_dashscope`。
20
+ - 使用内置 `slime_sft_terminal` 配方时,需要为 Agent 分配 8 张 GPU;如硬件数量不同,应创建与硬件拓扑匹配的配方,而不是直接复用此配方。
21
+
22
+ 项目的 Terminal 基准 ID 固定为:
23
+
24
+ ```text
25
+ terminal-bench__terminal-bench-2-1
26
+ ```
27
+
28
+ ## 2. 初始化项目与运行环境
29
+
30
+ ```bash
31
+ cd /path/to/vibetrainbench
32
+ export VTB_REPO="$PWD"
33
+
34
+ # 检查 Docker 和 GPU 是否可用
35
+ docker info
36
+ nvidia-smi
37
+
38
+ # 安装 Harbor/Pier 后端工具;工具会安装在 vtb-env/tools/ 下
39
+ bash scripts/install_backend_tools.sh
40
+ export PATH="$VTB_REPO/vtb-env/tools/bin:$PATH"
41
+
42
+ # 构建训练、vLLM 和 SGLang 镜像(首次执行耗时较长)
43
+ bash containers/build_image.sh all
44
+ ```
45
+
46
+ 可用以下命令查看项目解析到的运行时目录:
47
+
48
+ ```bash
49
+ python3 -m eval.runner.runtime_paths
50
+ ```
51
+
52
+ 默认目录如下:
53
+
54
+ ```text
55
+ vtb-env/
56
+ ├── model_cache/ # 手动准备的训练模型缓存
57
+ ├── hf_cache/ # Hugging Face 缓存
58
+ ├── tools/ # Harbor、Pier 和 uv 工具
59
+ ├── scratch/ # 每个任务的临时工作区
60
+ ├── results/ # 任务日志、final_model 和结果
61
+ └── grading_state/ # 评分服务状态和日志
62
+ ```
63
+
64
+ ## 3. 配置外层 Agent 的 API Key
65
+
66
+ 在项目根目录创建 `api_key.env`。此文件不应提交到 Git。
67
+
68
+ ```bash
69
+ cat > api_key.env <<'EOF'
70
+ # 使用 claude_dashscope 时必填;替换为真实密钥。
71
+ DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'
72
+
73
+ # 中国大陆端点使用 cn;国际端点使用 intl。
74
+ VTB_DASHSCOPE_REGION=cn
75
+ EOF
76
+ chmod 600 api_key.env
77
+ ```
78
+
79
+ 如改用其他外层 Agent:
80
+
81
+ - `claude`:在 `api_key.env` 中设置 `ANTHROPIC_API_KEY`。
82
+ - `codex`:在 `api_key.env` 中设置 `OPENAI_API_KEY`。
83
+
84
+ ## 4. 放置模型与训练数据
85
+
86
+ ### 4.1 基座模型
87
+
88
+ 内置 Terminal SFT 配方引用的模型资源为 `models/qwen3_5_9b_base`,其缓存位置必须保持以下结构:
89
+
90
+ ```text
91
+ vtb-env/model_cache/qwen3_5_9b_base/
92
+ ├── hf_checkpoint/ # Qwen/Qwen3.5-9B-Base 的 Hugging Face checkpoint
93
+ └── torch_dist/ # 与该 checkpoint 匹配的 Megatron torch_dist 转换结果
94
+ ```
95
+
96
+ `hf_checkpoint/` 内应直接包含 `config.json`、tokenizer 文件、权重分片等 Hugging Face 模型文件,而不是再嵌套一层模型目录。
97
+
98
+ 如果只提供 `hf_checkpoint/`,训练脚本会在首次运行时尝试生成缺失的 `torch_dist/`;提前准备二者可减少任务时间和网络依赖。若两个目录都不存在,脚本会尝试从命令中的模型 ID 下载模型,因此离线运行时必须提前放置模型。
99
+
100
+ 例如,从一个已下载的模型目录复制:
101
+
102
+ ```bash
103
+ mkdir -p vtb-env/model_cache/qwen3_5_9b_base
104
+ cp -a /path/to/qwen3_5_9b_base/hf_checkpoint \
105
+ vtb-env/model_cache/qwen3_5_9b_base/
106
+ cp -a /path/to/qwen3_5_9b_base/torch_dist \
107
+ vtb-env/model_cache/qwen3_5_9b_base/
108
+ ```
109
+
110
+ ### 4.2 Terminal SFT 数据
111
+
112
+ 内置配方使用的数据资源目录是:
113
+
114
+ ```text
115
+ training/resources/data/custom/terminal_sft_datasets/
116
+ ├── resource_config.json
117
+ └── data/
118
+ ├── terminaltraj_20k_sft_max32768.jsonl
119
+ ├── tmax_all_rts_style_qwen35_max32768.jsonl
120
+ └── rts_reward1_60k_sft_max32768.jsonl
121
+ ```
122
+
123
+ 将数据包解压或复制到以上路径,并保留 `resource_config.json` 与 `data/` 的相对层级。每个 JSONL 训练样本必须具有 `messages` 字段。
124
+
125
+ 可用以下命令检查资源是否就位:
126
+
127
+ ```bash
128
+ test -d vtb-env/model_cache/qwen3_5_9b_base/hf_checkpoint
129
+ test -f training/resources/data/custom/terminal_sft_datasets/resource_config.json
130
+ find training/resources/data/custom/terminal_sft_datasets/data -maxdepth 1 -name '*.jsonl' -type f
131
+ ```
132
+
133
+ > `terminal_sft_datasets` 含有多个 JSONL 文件。训练入口不会在多个候选文件间自动选择;Agent 应在其工作区中检查 `train_resource_manifest.lock.json`,并显式设置 `TRAIN_DATA` 为选定的数据文件。
134
+
135
+ ### 4.3 从 Hugging Face 恢复资源(可选)
136
+
137
+ 如果模型和数据分别发布在 Hugging Face 上,可用 `hf download` 下载到上述目标目录。以下命令中的仓库名和远端子目录请替换为实际发布位置:
138
+
139
+ ```bash
140
+ # 模型:下载后应得到 $VTB_ROOT/model_cache/qwen3_5_9b_base/hf_checkpoint/ 和 torch_dist/
141
+ hf download <MODEL_REPO_ID> \
142
+ --repo-type model \
143
+ --local-dir "$VTB_REPO/vtb-env/model_cache/qwen3_5_9b_base"
144
+
145
+ # 数据:下载后应得到 terminal_sft_datasets/resource_config.json 和 data/*.jsonl
146
+ hf download <DATASET_REPO_ID> \
147
+ --repo-type dataset \
148
+ --local-dir "$VTB_REPO/training/resources/data/custom/terminal_sft_datasets"
149
+ ```
150
+
151
+ 下载完成后必须重新执行上一节的本地检查;尤其注意 Hugging Face 仓库中是否额外多出了一层目录。
152
+
153
+ ## 5. 可选:预拉取 Terminal 任务镜像
154
+
155
+ Terminal 任务容器会在首次评测时由 Harbor 拉取。若计划长时间运行,建议预先拉取:
156
+
157
+ ```bash
158
+ bash scripts/prefetch_benchmark_images.sh \
159
+ --benchmarks terminal-bench__terminal-bench-2-1
160
+ ```
161
+
162
+ 该步骤可重复执行。
163
+
164
+ ## 6. 启动评分服务
165
+
166
+ `src/run_task.sh` 不会自行启动评分服务。必须先启动服务并确认健康状态。
167
+
168
+ ### 6.1 正常运行:评分与训练使用不同 GPU
169
+
170
+ 内置 `slime_sft_terminal` 配方为 Agent 使用 8 张 GPU。使用隔离模式时,主机至少需要 9 张 GPU;以下示例将 `0-7` 留给 Agent,并将 GPU `8` 留给评分服务。请按实际设备数量调整,两个 GPU 集合不能重叠。
171
+
172
+ ```bash
173
+ source src/commit_utils/set_env_vars.sh
174
+
175
+ VTB_GPU_COORDINATION_MODE=isolated \
176
+ VTB_EVAL_GPU=8 \
177
+ VTB_GRADING_PORT=5800 \
178
+ VTB_SERVE_BACKEND=sglang \
179
+ python3 -m eval.grading.server
180
+ ```
181
+
182
+ 此命令会持续运行。请在另一个终端检查服务:
183
+
184
+ ```bash
185
+ cd "$VTB_REPO"
186
+ source src/commit_utils/set_env_vars.sh
187
+ VTB_GRADING_PORT=5800 python3 -m eval.grading.client health
188
+ ```
189
+
190
+ ### 6.2 快速验证:评分与训练共享 GPU
191
+
192
+ 仅用于快速确认部署链路。它限制评分工作量,不应用于正常实验。
193
+
194
+ ```bash
195
+ cd "$VTB_REPO"
196
+ tmux new -d -s vtb_grading_smoke "cd '$VTB_REPO' && \
197
+ source src/commit_utils/set_env_vars.sh && \
198
+ VTB_GPU_COORDINATION_MODE=shared \
199
+ VTB_EVAL_GPUS=0,1,2,3,4,5,6,7 \
200
+ VTB_VAL_SOURCE=split:1 \
201
+ VTB_FINAL_LIMIT=1 \
202
+ VTB_GRADING_PORT=5800 \
203
+ VTB_SERVE_BACKEND=sglang \
204
+ python3 -m eval.grading.server"
205
+
206
+ VTB_GRADING_PORT=5800 python3 -m eval.grading.client health
207
+ ```
208
+
209
+ ## 7. 先做无训练烟测
210
+
211
+ 在正式运行前,建议验证容器、API Key、模型交付和评分服务的完整链路。该测试不使用 Terminal SFT 数据:
212
+
213
+ ```bash
214
+ cd "$VTB_REPO"
215
+ VTB_PROMPT=mock_test \
216
+ VTB_GRADING_PORT=5800 \
217
+ bash src/run_task.sh \
218
+ aime__aime \
219
+ claude_dashscope \
220
+ Qwen/Qwen3-1.7B-Base \
221
+ smoke \
222
+ 1 \
223
+ qwen3.8-max \
224
+ 1
225
+ ```
226
+
227
+ 确认任务结果目录中出现日志和 `metrics.json` 后,再运行 Terminal 训练任务。
228
+
229
+ ## 8. 启动 Terminal SFT 训练任务
230
+
231
+ 以下示例使用内置的 `slime_sft_terminal` 配方、Qwen3.5-9B-Base 和 8 张 Agent GPU:
232
+
233
+ ```bash
234
+ cd "$VTB_REPO"
235
+ source src/commit_utils/set_env_vars.sh
236
+
237
+ VTB_PROMPT=train_test \
238
+ VTB_GRADING_PORT=5800 \
239
+ VTB_AGENT_GPUS=0,1,2,3,4,5,6,7 \
240
+ VTB_TRAIN_RECIPE=train_test/qwen3_5_9b/slime_sft_terminal \
241
+ VTB_EXPERIMENT_NAME=_terminal_sft_first_run \
242
+ bash src/run_task.sh \
243
+ terminal-bench__terminal-bench-2-1 \
244
+ claude_dashscope \
245
+ Qwen/Qwen3.5-9B-Base \
246
+ terminal_first_run \
247
+ 2 \
248
+ qwen3.8-max \
249
+ 8
250
+ ```
251
+
252
+ 参数含义:
253
+
254
+ | 参数 | 示例值 | 说明 |
255
+ |---|---|---|
256
+ | benchmark | `terminal-bench__terminal-bench-2-1` | Terminal 基准 ID |
257
+ | agent | `claude_dashscope` | 外层 Research Agent 类型 |
258
+ | base model | `Qwen/Qwen3.5-9B-Base` | 交给 Agent 训练的基座模型标识 |
259
+ | run ID | `terminal_first_run` | 本次运行的唯一名称 |
260
+ | hours | `2` | Agent 的总墙钟时间预算 |
261
+ | agent config | `qwen3.8-max` | 外层 Agent 使用的服务端模型名 |
262
+ | num GPUs | `8` | 传给 Agent 容器的 GPU 数量 |
263
+
264
+ `VTB_TRAIN_RECIPE` 必须显式设置;配方文件不会仅因存在于 `training/recipes/` 下而被自动加载。
265
+
266
+ ## 9. 监控和查看结果
267
+
268
+ 运行期间可使用:
269
+
270
+ ```bash
271
+ nvidia-smi
272
+ tail -f vtb-env/grading_state/service.log
273
+ ```
274
+
275
+ 每个任务的主要输出位于:
276
+
277
+ ```text
278
+ vtb-env/results/<agent>_<agent-config>_<hours>h.../
279
+ terminal-bench__terminal-bench-2-1_<model>_<run-id>/
280
+ ```
281
+
282
+ 重点文件:
283
+
284
+ - `output.log`、`error.log`:主启动脚本输出。
285
+ - `solve_out.txt`:外层 Agent 的执行记录。
286
+ - `prompt.txt`:本次运行使用的任务提示。
287
+ - `final_model/`:交付给评分服务的模型。
288
+ - `metrics.json`:评分完成后写入的结果。
289
+
290
+ 评分服务的运行日志位于 `vtb-env/grading_state/`。
291
+
292
+ ## 10. 常见问题
293
+
294
+ ### `docker info` 失败
295
+
296
+ 先启动 Docker daemon,或确认当前用户有访问 Docker socket 的权限。若使用 rootless Docker,需要设置 `VTB_DOCKER_ROOTLESS=1` 后再运行项目命令。
297
+
298
+ ### 找不到 `harbor` 或 `pier`
299
+
300
+ 重新运行:
301
+
302
+ ```bash
303
+ bash scripts/install_backend_tools.sh
304
+ export PATH="$VTB_REPO/vtb-env/tools/bin:$PATH"
305
+ ```
306
+
307
+ ### 评分服务健康检查失败
308
+
309
+ 确认评分服务仍在运行、`VTB_GRADING_PORT` 与服务启动时一致,且训练 GPU 与评分 GPU 的配置符合所选协调模式。
310
+
311
+ ### `HF_CHECKPOINT not found` 或模型转换耗时很长
312
+
313
+ 检查 `vtb-env/model_cache/qwen3_5_9b_base/hf_checkpoint/` 是否存在且内容完整。若提前提供匹配的 `torch_dist/`,可避免首次转换。
314
+
315
+ ### `Multiple train_data candidates found`
316
+
317
+ 数据资源中有多个 JSONL 文件。请在 Agent 工作区内显式设置 `TRAIN_DATA` 为选定的单个 JSONL 文件,再运行 SFT 入口。
318
+
319
+ ### `403 invalid api-key`
320
+
321
+ 检查 `DASHSCOPE_API_KEY` 是否正确,并确认 `VTB_DASHSCOPE_REGION` 与密钥所属区域一致(`cn` 或 `intl`)。