Upload README.md with huggingface_hub

README.md

@@ -6,61 +6,53 @@ tags:
   - agents
   - tool-use
   - code
+  - games
 ---
 
 # GymCL 数据集（`Septzzz/gymcl-data`）
 
-[GymCL](https://github.com/Septzzz/GymCL) 持续学习基准 v1 stream 所需的数据。
-它服务 **games + code + tool** 三类环境（共 18 个 env id）。
+[GymCL](https://github.com/Septzzz/GymCL) 持续学习基准的数据。核心是 **`unified/`**：
+每个任务一份**统一格式的 golden `train` + `test`**，可直接用于 SFT / 离线评测。
 
-## 两种数据角色（为什么格式不统一）
+## `unified/` — 统一 golden 数据（10 个任务）
 
-GymCL 是**智能体持续学习基准**，评测 = 在交互环境里作答，**不是**静态 (输入,标签) 表。
-因此数据天然分两类，无法都压成对称的“一个 train 一个 test”：
-
-1. **环境运行资产（native）** —— 评测环境实例化时必须加载的原始文件（tau2 的 domain
-   数据库/policy、toolbench 的工具 API schema + 指令集、apibench 的 API 列表、SWE-smith
-   的实例 parquet）。它们**不能**被拍平成表，否则环境跑不起来。
-2. **训练候选池 / 可离线判定的评测** —— 可归一成统一 schema（见 `unified/`）。
-
-## 目录一览
+统一逐行 schema（train 与 test 同一种）：
+```json
+{"messages": [{"role":"...","content":"..."}], "reward": 1.0 或 null, "meta": {"task","env_id","instance","source", ...}}
+```
+- **train.jsonl** —— **golden 轨迹**：`messages` 含完整 `user/assistant(/tool)`，`reward=1.0`。
+- **test.jsonl** —— 输入侧 `messages`；有 gold 的把标准答案放 `meta.gold`，`meta.grader` 标明判分方式，`reward=null`。
 
-| 目录 | 内容 / 格式 | 角色 | 被谁使用 |
+| 类 | 任务 | train golden 来源 | test |
 |---|---|---|---|
-| `SWE-smith/` | parquet（instance_id / problem_statement / patch） | 环境运行资产 + swe gold | `code:swe-smith-agent` 评测实例 |
-| `tau2/` | `domains/<domain>/`（DB/policy/tasks）+ `user_simulator/` | 环境运行资产 | `tool:tau2-*`（经 `TAU2_DATA_DIR` 加载） |
-| `toolbench/` | `toolenv/tools/`（API schema）+ `test_instruction/G{1,2,3}_instruction.json` + `toolllama_G123_dfs_{train,eval}.json` | 环境资产 + 训练轨迹 | `tool:toolbench-g{1,2,3}` |
-| `apibench/` | `{subset}_{eval,train}.json`（JSONL） | 静态评测 + gold train | `tool:apibench-gorilla-*` |
-| `unified/` | **统一视图**：见下 | 对外统一层 | 外部 SFT/评测直接取用 |
-
-> 另有部分数据在**运行时**直接从公共 HF Hub 拉取，不在本仓库：MBPP
-> (`google-research-datasets/mbpp`)、R2E-Gym-Lite (`R2E-Gym/R2E-Gym-Lite`)、
-> SWE-smith / R2E-Gym 轨迹池。
-
-## `unified/` — 统一层（由 `scripts/build_unified.py` 生成）
-
-每个任务一个目录 `unified/<task>/`：
-
-- **`train.jsonl`** —— 统一 episode schema：
-  `{"messages": [{role, content}...], "final_reward": float, "num_steps": int, "meta": {...}}`。
-  仅对**本地可归一**的训练池直接产出（如 toolbench、apibench）；HF-hub 池默认在
-  `manifest.json` 里写指针（`--fetch` 时才materialize）；games/tau2 的 train 由 teacher
-  rollout / 实例划分在运行时生成，故以描述符记录在 manifest。
-- **`test.jsonl`** —— 统一外壳，按环境类型分两种 `kind`：
-  - `kind="static"`（apibench，及 hub 指针的 mbpp）：`{task, env_id, grader, input, gold}`，可离线判定。
-  - `kind="interactive"`（games/tau2/toolbench/r2egym）：`{task, env_id, grader, env_kwargs,
-    instance, source}` —— 是“去环境里运行”的**指针**，标签由环境现算（非存储）。
-- **`manifest.json`** —— 逐任务列出 train 来源/kind、test kind、判分方式（grader）、条数、依赖资产。
-
-> 交互类环境（games/tau2/toolbench/r2egym）**没有**静态 test 表：其“测试集”是一组要在环境里
-> 运行的实例/种子，评分由环境（引擎 reward / tau2 evaluator / LLM judge / docker 测试）现算。
+| code | `swe_smith` | SWE-smith-trajectories（resolved 多轮轨迹，5000） | SWE-smith held-out（problem→patch gold） |
+| code | `swebench_verified` | R2EGym-SFT-Trajectories（多轮，3231） | SWE-bench_Verified 500（problem→patch gold） |
+| code | `terminal_bench` | Terminal-Bench **2.0** 轨迹（reward>0，5000） | TB2.0 任务（instruction→gold `solve.sh`，89） |
+| tool | `toolbench_g1` | ToolLLaMA G123 DFS 轨迹（5000） | G1 query（LLM judge） |
+| tool | `apibench_hf` | apibench huggingface_train（instruction→api_call gold，8191） | huggingface_eval（gold，911） |
+| tool | `bfcl` | BFCL **16 个 gold 类别**（单轮 user→gold 调用 / 多轮逐轮调用，3200） | held-out 10%（gold in meta，356） |
+| game | `mastermind` | **oracle**（一致性消元推理轨迹，200） | 50 eval seeds（env 评分） |
+| game | `sokoban` | **oracle**（BFS 最优推箱，200） | 50 eval seeds |
+| game | `fifteen_puzzle` | **oracle**（A* 最优解，200） | 50 eval seeds |
+| game | `minesweeper` | **oracle**（首翻+标雷+清安全格，200） | 50 eval seeds |
+
+设计说明：
+- **游戏无现成轨迹** → 用程序化 **oracle 求解器**在真环境里跑出最优 golden 轨迹（`env.step` 校验 reward）。
+- **bfcl 替换了 tau2**（tau2 无 golden 轨迹）；**mbpp 已移除**（只有单步 gold、无多轮轨迹）。
+- **games / bfcl-test / toolbench-test** 由环境现场评分（引擎 reward / bfcl checker / LLM judge），故 `reward=null`、gold（若有）在 `meta`。
+- **terminal_bench 的实时评测**需 terminal-bench/harbor harness + Docker（不影响本数据的使用）。
+
+## 原生环境资产（供实际跑环境用，非 golden 数据）
+
+部分环境运行时需要原生资产（工具 schema、实例 parquet 等），与 `unified/` 并列存放：
+`SWE-smith/`、`toolbench/`、`apibench/` 等。运行时另有从公共 Hub 直接拉取的（R2E-Gym-Lite、MBPP、各轨迹池、TB2.0 任务集）。
 
 ## 用法
 
 ```bash
-# 下载（GymCL setup.sh 会自动调用）
-python scripts/download_data.py
-# 直接取统一层做自己的 SFT / 离线评测
-#   unified/<task>/train.jsonl  (messages)
-#   unified/<task>/test.jsonl   (static: input+gold / interactive: 运行指针)
+python scripts/download_data.py          # GymCL setup.sh 会自动调用
+# 直接取统一 golden 数据做 SFT / 评测：
+#   unified/<task>/train.jsonl   (golden messages, reward=1.0)
+#   unified/<task>/test.jsonl    (输入 + meta.gold / 或待跑实例)
+#   unified/manifest.json        (各任务 train/test 条数)
 ```