scripts/USAGE.md

TraceSpatial-Trace 转换与上传

这套脚本把已有 RGB + QA 数据转换为 HF Dataset Viewer 可直接浏览的 Parquet。它不是 RoboTracer 上游数据生成或训练代码。

环境

本机已安装环境 tracespatial-hf。在 Miniforge Prompt 中执行：

conda activate tracespatial-hf
cd C:\Users\lee\Desktop\TraceSpatial-release-work\release\scripts

其他机器在本目录运行：

conda env create -f environment.yml
conda activate tracespatial-hf

已有 Python 3.11 环境也可用 python -m pip install -r requirements.txt。不需要 CUDA/GPU。

小样本验证

python convert_dataset.py --input "C:\Users\lee\Desktop\TraceSpatial-Trace\TraceSpatial-Trace" --output "C:\Users\lee\Desktop\TraceSpatial-parallel-preview-v2" --workers 24 --chunk-records 4 --limit-records 64 --verify-images

每个来源取前 64 条原始记录，然后拆出全部 QA。preview 仅是演示子集，不是统计随机样本或测试集。

全量多进程转换（v2）

v2 的工作块/检查点与旧版不兼容，请使用新的输出目录，不要把旧版 v1 输出作为 v2 续跑目录。--chunk-records 控制任务粒度，默认 2048 条原始记录；小样本测试可设为 4，让多个进程也能同时处理同一来源。

python convert_dataset.py --input "C:\Users\lee\Desktop\TraceSpatial-Trace\TraceSpatial-Trace" --output "C:\Users\lee\Desktop\TraceSpatial-full-release-v2" --workers 24 --chunk-records 2048 --shard-mib 512 --row-group-mib 32

• 原始 images/ 和 metadata/ 不修改。只读取被 QA 引用的 RGB 图像。
• 先将各来源 JSON 流式拆为 JSONL 工作块，再由共享进程池动态领取；同一来源可以同时由多个进程转换，不再有五进程上限。默认最多 24 个进程，也可指定 --workers 32。本机 32 个逻辑处理器、约 128 GB 内存，已实测 24 个进程参与处理。
• 每行独立包含 RGB、问题、答案、type、source、task、id、qa_index、record_index。
• record_index 是原始 JSON 数组中的位置。重复 id 不去重，也不丢失问答。
• 保留原始图像字节，不重编码；保留原始 QA 字符串；缺失 type 留 null。
• 严格检查单图引用、配对角色与文本类型；遇到缺图或格式错误会报错，不静默跳过。
• --verify-images 可额外对所有引用图像解码校验，代价是更长运行时间。
• 512 MiB 指近似未压缩内容阈值，实际 Parquet 大小取决于压缩；分片在整条原始记录结束后切分，单条超大记录可能超过阈值。
• 每个 row group 约 32 MiB，最多 128 行，单张图片上限 64 MiB。Arrow 的编码缓冲会额外占内存，24 进程时行组缓冲会成倍增加；磁盘吞吐也会影响加速比。
• 每行嵌入图像，逻辑内容量会因重复图像超过原始包；字典编码与 Zstd 减少行组内重复。不要把 189.6 GB 原始大小当作发布文件大小。

中断与续跑

原命令再次执行即可。每个完整分片写入 .state/<source>-<chunk_id>.json 后才算完成；已完成分片会校验 SHA-256 并跳过，不完整分片重新写入。拆块结果保存在 .state/chunks/，首次准备阶段按来源顺序流式读取 JSON，只保存标注、不复制图片。后续恢复复用工作块，仅在未完成块内跳过已经处理的记录；JSONL 块会额外占用数 GB 磁盘空间。

保持原始图片不变。恢复身份会检查 JSON 路径、大小、mtime、脚本哈希和转换参数，但不会给 50 多万张原始图片逐一建立内容快照。原图或元数据、转换参数、代码发生变化时，应使用新的输出目录。改变 --workers 不改变数据，可以用于调整并发。

.state/conversion.log 保存块级进度；终端显示逐分片进度。Windows 后台启动示例：

Start-Process -FilePath "$env:CONDA_PREFIX\python.exe" -ArgumentList @('convert_dataset.py', '--input', '"C:\Users\lee\Desktop\TraceSpatial-Trace\TraceSpatial-Trace"', '--output', '"C:\Users\lee\Desktop\TraceSpatial-full-release-v2"', '--workers', '24') -WorkingDirectory (Get-Location).Path -WindowStyle Hidden -RedirectStandardOutput '..\conversion.stdout.log' -RedirectStandardError '..\conversion.stderr.log'

只在没有其他转换进程使用同一输出目录时启动；脚本还会通过文件锁阻止并发写入。

上传

先登录，不要将 token 写入脚本：

hf auth login
hf auth whoami

先校验文件和展示计划（无网络写入）：

python upload_dataset.py --folder "C:\Users\lee\Desktop\TraceSpatial-full-release-v2" --repo-id leeibo/TraceSpatial-Trace --workers 4

正式上传：

python upload_dataset.py --folder "C:\Users\lee\Desktop\TraceSpatial-full-release-v2" --repo-id leeibo/TraceSpatial-Trace --workers 4 --execute

默认使用当前 upload_folder + hf_xet 的并发、分批提交与续传实现。--workers 默认控制本地 SHA-256 并行验证；现代上传路径的网络并发由 SDK/Xet 管理。必须安装 requirements 中的 hf-xet。

如需明确控制 SDK 上传 worker 数，可以额外指定 --legacy-workers：它使用当前仍可用但上游已弃用的 upload_large_folder(num_workers=...)。默认不采用该兼容模式。

重复上传命令可恢复未完成上传，不要启动多个上传进程。.state/upload.log 保存状态，HF 的缓存用于恢复。不会删除远端文件；不会更改现有仓库的公开/私有状态；不存在的仓库以私有方式创建。上传前需要完整 manifest，并校验全部分片；上传后检查远端大小以及可用的 LFS SHA-256。

注意：当 SDK 分批提交时，中途失败可能已提交部分文件。完成并通过末尾验证后才算整次上传成功。 此时再重新运行即可。脚本不会自动付费升级存储或切换仓库可见性。

输出结构

release/
  README.md
  manifest.json
  data/agibot/train-00000-000.parquet
  data/ca1m/...
  data/droid/...
  data/robotwin/...
  data/scannet/...
  scripts/
  .state/                   # 本地检查点与日志，不上传

README 由 README.template.md 加上实际转换规模和 HF configs 生成。完整转换提供 all 和五个来源配置；小样本转换提供 preview 和各来源配置。

全量完成不等于立即公开。许可证仍需维护者确定。私有仓库的 Viewer 能否显示取决于 HF 账户能力；原始上传和已授权用户的下载不等同于在线 Viewer 支持。