Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,69 @@
+---
+license: other
+task_categories:
+- robotics
+tags:
+- autonomous-driving
+- nuplan
+- navsim
+- autovla
+---
+
+# NAVSIM navtrain metric cache
+
+NAVSIM `navtrain` split 的 **metric cache**，用于 PDM score 计算（AutoVLA 等做 RL/GRPO 训练时的 reward，
+或跑 PDMS 评测）。纯 CPU 产物，与模型无关，一次生成可永久复用。
+
+| | |
+|---|---|
+| 场景数 | **103,288**（train 101,288 + val 2,000） |
+| 大小 | 35 GB（解包后） |
+| 生成 | `navsim/planning/script/run_metric_caching.py`，`train_test_split=navtrain` |
+| 覆盖率 | 对 navtrain 的 101,288 个训练样本 **100% 覆盖，缺 0** |
+
+每个 `metric_cache.pkl`（lzma 压缩，约 450 KB）含 PDMScorer 判分所需的全部内容：
+`ego_state`、`trajectory`（PDM 参考轨迹）、`observation`（各时刻 agent 占用）、
+`centerline`、`route_lane_ids`、`drivable_area_map`。
+
+## 下载与解包
+
+```bash
+huggingface-cli download PhoenixHu/doc_vla_cache_train --repo-type dataset --local-dir .
+cat navtrain_metric_cache.tar.part* | tar xf -
+# -> navtrain_metric_cache/
+```
+
+## 🔴 必读：解包后必须改写 metadata 里的绝对路径
+
+`metadata/navtrain_metric_cache_metadata_node_0.csv` 里存的是**生成时那台机器的绝对路径**
+（`/scratch/mh2803/vla/nuplan/navtrain_metric_cache/...`）。`MetricCacheLoader` 会**原样拿它开文件**：
+
+```python
+# navsim/common/dataloader.py
+metadata_file = [f for f in metadata_dir.iterdir() if ".csv" in str(f)][0]   # 注意是子串匹配
+cache_paths   = f.read().splitlines()[1:]                                    # 绝对路径，直接使用
+```
+
+不改的话症状是：**每个场景都 `Agent failed`、PDMS 全 0**，而 `.pkl` 明明就在本地。
+
+```bash
+NEW=/your/path/to/navtrain_metric_cache
+sed -i "s#/scratch/mh2803/vla/nuplan/navtrain_metric_cache#${NEW}#g" \
+    "$NEW"/metadata/*.csv
+```
+
+⚠️ **备份不要放在 `metadata/` 里面** —— 上面那行是 `".csv" in str(f)` 的**子串**匹配，
+`xxx.csv.bak` 也会被选中，`[0]` 可能挑到它，等于没改。备份放到 `metadata/` 之外。
+
+改完自检：
+
+```python
+from pathlib import Path
+from navsim.common.dataloader import MetricCacheLoader
+print(len(MetricCacheLoader(Path("<你的路径>")).tokens))   # 应为 103288
+```
+
+## 许可
+
+派生自 [nuPlan](https://www.nuscenes.org/nuplan) / [OpenScene](https://github.com/OpenDriveLab/OpenScene)，
+请遵守其原始许可条款。本仓库仅为已授权用户提供预计算的中间产物，不含任何原始传感器数据或标注。