chenyuwang1 commited on
Commit
033b4f8
·
verified ·
1 Parent(s): 9f05886

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +233 -3
README.md CHANGED
@@ -1,3 +1,233 @@
1
- ---
2
- license: unknown
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ task_categories:
4
+ - reinforcement-learning
5
+ tags:
6
+ - hierarchical-rl
7
+ - maxq
8
+ - value-decomposition
9
+ - offline-rl
10
+ - trajectories
11
+ pretty_name: Hierarchical Value Decomposition (MAXQ) — Rebuttal Dataset
12
+ size_categories:
13
+ - 1K<n<10K
14
+ language:
15
+ - en
16
+ ---
17
+
18
+ # Hierarchical Value Decomposition (MAXQ) — Rebuttal Dataset
19
+
20
+ [![Dataset on HuggingFace](https://img.shields.io/badge/🤗%20Dataset-HuggingFace-yellow)](https://huggingface.co/datasets/<your-username>/hvd-maxq-rebuttal)
21
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
22
+
23
+ **🔗 Access Dataset:** https://huggingface.co/datasets/<your-username>/hvd-maxq-rebuttal
24
+
25
+ ---
26
+
27
+ ## 📊 Dataset Overview
28
+
29
+ 本数据集用于支撑论文“Hierarchical Reinforcement Learning with the MAXQ Value Function Decomposition”相关的复现实验与 rebuttal,对外提供分层任务轨迹、层级边界标注、奖励与价值分解信息、训练日志与评估结果。[JAIR/2000][1],[arXiv][5]
30
+
31
+ ### 关键内容
32
+
33
+ - 分层轨迹:按子任务/子例程划分的`state, action, reward, next_state, done`序列
34
+ - 层级标注:`hierarchy_level`、`subtask_id`、进入/退出条件、抽象状态信息
35
+ - 价值分解:用于 MAXQ 的加性价值分解字段与局部回报统计
36
+ - 训练/评估:不同随机种子与超参数的训练日志、评估回报与方差
37
+
38
+ ### 关键统计(待补全)
39
+
40
+ - 任务数:<填写数量>
41
+ - 总轨迹数:<填写数量>
42
+ - 数据体量:<填写GB>
43
+ - 训练随机种子:<seed 列表>
44
+ - 评估指标:平均回报 ± 方差(按任务/层级)
45
+
46
+ ### 数据模态覆盖(待补全)
47
+
48
+ - 轨迹文件:<格式,如 npz/hdf5/jsonl>
49
+ - 层级标注:<文件或内嵌字段>
50
+ - 日志与模型引用:<日志文件>;策略权重建议在模型仓库发布并在此引用
51
+
52
+ ---
53
+
54
+ ## 🚀 Quick Start
55
+
56
+ ### 1) 仅加载数据集元数据
57
+
58
+ ```python
59
+ from datasets import load_dataset
60
+
61
+ dataset = load_dataset("<your-username>/hvd-maxq-rebuttal")
62
+ episode = dataset['train'][0]
63
+ print(episode['episode_id'])
64
+ print(episode['env_name'])
65
+ print(len(episode['transitions']))
66
+ ```
67
+
68
+ ### 2) 按需下载特定文件
69
+
70
+ ```python
71
+ from huggingface_hub import hf_hub_download
72
+
73
+ traj_path = hf_hub_download(
74
+ repo_id="<your-username>/hvd-maxq-rebuttal",
75
+ filename="trajectories/<episode_id>.npz",
76
+ repo_type="dataset",
77
+ )
78
+
79
+ hier_path = hf_hub_download(
80
+ repo_id="<your-username>/hvd-maxq-rebuttal",
81
+ filename="hierarchy/<episode_id>.json",
82
+ repo_type="dataset",
83
+ )
84
+ ```
85
+
86
+ ### 3) 克隆完整数据集(含大型文件)
87
+
88
+ ```bash
89
+ git lfs install
90
+ git clone https://huggingface.co/datasets/<your-username>/hvd-maxq-rebuttal
91
+ ```
92
+
93
+ ---
94
+
95
+ ## 📚 数据字段说明
96
+
97
+ 每个`episode`包含:
98
+
99
+ ### 元数据字段
100
+
101
+ - `episode_id`: 唯一标识
102
+ - `env_name`: 环境或任务名称
103
+ - `hierarchy_spec`: 层级结构摘要(JSON 字符串或对象)
104
+ - `seed`: 随机种子
105
+ - `algo`: 训练算法(如 MAXQ-Q)
106
+ - `hyperparams`: 关键超参数摘要
107
+
108
+ ### 序列数据
109
+
110
+ - `transitions`: 列表项包含 `state`, `action`, `reward`, `next_state`, `done`
111
+ - `subtasks`: 子任务序列与边界,含 `subtask_id`, `level`, `enter_t`, `exit_t`
112
+ - `value_decomp`: 分解后的价值或回报统计(用于加性分解的相关量)
113
+
114
+ ---
115
+
116
+ ## 💡 使用示例
117
+
118
+ ### 1) 浏览与筛选
119
+
120
+ ```python
121
+ from datasets import load_dataset
122
+
123
+ ds = load_dataset("<your-username>/hvd-maxq-rebuttal")
124
+ train = ds['train']
125
+ filtered = train.filter(lambda x: x['env_name'] == '<env>' and x['seed'] == 0)
126
+ print(len(filtered))
127
+ ```
128
+
129
+ ### 2) 构建层级滚动回放
130
+
131
+ ```python
132
+ episode = train[0]
133
+ for st in episode['subtasks']:
134
+ seg = episode['transitions'][st['enter_t']:st['exit_t']]
135
+ # 在此进行子任务级评估或可视化
136
+ ```
137
+
138
+ ### 3) 价值分解校验(示例占位)
139
+
140
+ ```python
141
+ import numpy as np
142
+
143
+ vd = episode['value_decomp']
144
+ _ = np.array(vd['local_returns']).sum()
145
+ ```
146
+
147
+ ---
148
+
149
+ ## 🎯 适用场景
150
+
151
+ - 分层强化学习复现与评估(MAXQ 框架)
152
+ - 离线强化学习与价值分解方法研究
153
+ - 子任务/抽象状态设计与层级策略分析
154
+ - 与模型仓库中策略权重联合使用进行端到端评测
155
+
156
+ ---
157
+
158
+ ## 📖 数据集细节(待补全)
159
+
160
+ ### 数据来源与生成
161
+
162
+ - 环境:<列出实验环境/任务>
163
+ - 采集流程:<说明采集管线、抽象/子任务划分策略>
164
+ - 训练配置:<训练步数、学习率、探索策略等>
165
+
166
+ ### 评估设置
167
+
168
+ - 指标:平均回报、方差、收敛步数等
169
+ - 重复次数与随机种子:<填写>
170
+
171
+ ---
172
+
173
+ ## 🔐 隐私与合规
174
+
175
+ - 数据来源于仿真,未包含个人隐私信息
176
+ - 许可证与使用限制:见下方 License
177
+
178
+ ---
179
+
180
+ ## ⚠️ 已知局限(待补全)
181
+
182
+ - 层级标注依赖特定实现,跨环境迁移需校验
183
+ - 抽象状态选择可能影响价值分解稳定性
184
+
185
+ ---
186
+
187
+ ## 📜 License
188
+
189
+ MIT License - 见 `LICENSE`
190
+
191
+ ---
192
+
193
+ ## 📚 引用
194
+
195
+ ### 论文
196
+
197
+ > Dietterich, T. G. (2000). Hierarchical Reinforcement Learning with the MAXQ Value Function Decomposition. Journal of Artificial Intelligence Research. [JAIR][1], [arXiv][5]
198
+
199
+ ### 数据集
200
+
201
+ ```bibtex
202
+ @dataset{hvd_maxq_rebuttal_2025,
203
+ title={Hierarchical Value Decomposition (MAXQ) — Rebuttal Dataset},
204
+ author={<your name>},
205
+ year={2025},
206
+ publisher={HuggingFace},
207
+ url={https://huggingface.co/datasets/<your-username>/hvd-maxq-rebuttal}
208
+ }
209
+ ```
210
+
211
+ ---
212
+
213
+ ## 👥 Authors
214
+
215
+ <your name(s)>
216
+
217
+ ---
218
+
219
+ ## 📞 Contact & Contributions
220
+
221
+ - 在数据集页面开启讨论或提 Issue
222
+ - 联系邮箱:<your email>
223
+
224
+ ---
225
+
226
+ ## 📋 Changelog
227
+
228
+ - v1.0 (2025): 首次公开发布,含核心层级轨迹与评估结果
229
+
230
+ ---
231
+
232
+ [1]: https://jair.org/index.php/jair/article/view/10266
233
+ [5]: https://arxiv.org/abs/cs/9905014