Replace ReInterHand shared-v1.0 with the verified shared-v1.1 release (candidate PR) (#8)

8f94cdb 24 days ago

preview code

Raw History Blame Contribute Delete

14.8 kB

ReInterHand shared-v1.1 已完成本地全量迁移与自动验收（逐字段字节级比对）；人工复查与 HF 发布尚未完成。

手物数据仓库统一约定 v1.1：张量合并存储

格式版本：hand-warehouse/1.1。张量存储约定：pt/tensor_bundle/v1。

状态：ReInterHand shared-v1.1 配套注册表与读写工具已适配；本地全量数值一致性及结构检查通过，发布清单已在发布树外重建（tmp/reinterhand-tools/PUBLISH_MANIFEST.json，树内不含清单）。人工复查不属于自动验收，尚未完成；HF 发布尚未进行。

本版以 v1.0 合同为语义基础：任务范围、两层序列/相机组织、数据类型、单位、坐标系、时间对齐、左右手顺序、官方划分、view_type、来源、可用监督规则、媒体无损编码和验收要求均保留。下文仅替代数值张量组件的独立 Tensor 文件、对应 *_valid.pt 及文件引用规定；这些旧文件名仅用于识别对应逻辑字段。媒体和 JSONL 组件的有效性文件及引用保持 v1.0，不纳入合并。未明确改变的语义继续执行 v1.0。

本版按用户约定作为 v1.0 的小版本存储修订，后续所有数据集逐步迁移到 v1.1。数值字段与 valid 语义不变，但 .pt 物理结构和引用方式改变，旧读取器不能未经适配直接读取新字典。各数据集在原 shared-v1.0 目录内逐步升级，完整验收后将目录更名为 shared-v1.1，不长期保留两套发布树。最终 metainfo.schema_version=hand-warehouse/1.1、release_id=shared-v1.1；尚未迁移的数据集仍使用原目录和版本。升级与发布流程见 MIGRATION.md。实施前须按配套 v1.1 注册表完成读写/校验工具；不得将 v1.0 的 schema.json 改个版本号作为已完成适配的证明。正式发布时须提供完整合同与匹配注册表，不依赖本地草案目录中的相对链接。

1. 合并边界

数值张量与对应有效性必须在同一个 .pt 文件、同一个字段字典内保存：{"data": Tensor, "valid": BoolTensor}。这些数值张量组件不再生成独立的 *_valid.pt；媒体和 JSONL 的有效性文件不受此规则影响。
按组件合并经常一起读取的小张量：相机内参、外参、畸变放在一个 camera.pt；MANO 参数与整手可见性放在一个 mano.pt；手关键点的二维、三维与可见性放在一个 keypoints.pt。
每个物体的数值字段及全部部件数值字段合并为一个 object.pt。不同物体、不同相机、不同序列不合成一个全局大文件，以保留按需下载和读取能力。
RGB、深度、栅格 mask 继续使用原无损媒体格式，不把解码后的大数组或媒体字节塞进 .pt。它们的有效性文件保持原文件名、Tensor/媒体格式、形状和引用方式，不包装为字典。
metainfo.json、camera/frames.jsonl、实例映射、物体身份/运动学定义与网格资产保留原格式。此次不把 JSON、JSONL、OBJ、纹理全部打进一个字典。

合并只改变存储方式，不改变采样、帧数、张量内容或有效性判定。不为减少字段数而将多个组件的 valid 合成一个公共 valid。

2. 目录

<dataset>/shared-v1.1/
  doc/                              # 完整合同、匹配 schema、字段映射、验收报告
  script/                           # 转换、读取和校验代码
  data/<sequence_id>/<camera_id>/
    metainfo.json
    observation/
      rgb.mkv
      rgb_valid.pt                  # 原独立 bool Tensor，保持不变
      depth.mkv
      depth_valid.mkv               # 逐像素有效性，保留压缩媒体格式
    camera/
      frames.jsonl
      camera.pt                     # intrinsic、extrinsic、distortion
    annotation/
      mano/mano.pt                  # motion、visibility
      keypoints/keypoints.pt        # uv、xyz、visibility、whole_hand_visibility
      object/<object_id>/
        metainfo.json
        articulation.json           # 仅关节/部件结构实际存在时
        object.pt                   # 位姿、可见性、几何点、关节、部件数值
        assets/                     # 原网格、材质、纹理及依赖
      segment/
        mask.mkv                    # 或 polygons.jsonl，按所选表示
        instances.jsonl             # 仅需要实例/区域编码映射时
        mask_valid.pt               # 原帧级 bool Tensor，保持不变
      contact/
        relations.jsonl
        relations_valid.pt          # 原帧级 bool Tensor，保持不变
        <subject_id>__<object_id>/
          contact.pt                # vertex_region、vertex_distance

只创建实际提供的组件和字段。以上不是每个数据集必须填满的模板；缺失内参、MANO、深度等不能通过占位文件伪装为已提供。序列/相机的两层结构不变，物体与模态目录属于相机内部组件。

3. 字典结构与有效性

本次合并的数值组件 .pt 根对象为字符串键的 Python dict，内部仅允许嵌套字符串键字典和 CPU torch.Tensor，不保存自定义类、模型、NumPy 对象或任意可执行对象。元信息、schema、单位和来源放在 metainfo，不在每个张量条目中重复保存。读取使用 torch.load(path, map_location="cpu", weights_only=True)。第 4 节保留的独立有效性 .pt 根对象仍为 CPU bool Tensor，不适用字典结构要求。

例如，camera/camera.pt 的逻辑结构为：

{
    "intrinsic": {"data": K, "valid": K_valid},
    "extrinsic": {"data": T_camera_from_world, "valid": extrinsic_valid},
    "distortion": {"data": distortion, "valid": distortion_valid},
}

以上变量均为 Tensor。未提供的字段整个省略；例如无世界系外参时不保存 extrinsic，不填单位矩阵。没有单独畸变向量的模型不创建 distortion：Fisheye624 仍使用既定 [T,15] 内参参数布局。

数值字段统一为 data 与 valid 两个叶子。源属性原先显式声明全已知 valid=true 时，迁移可按该属性的有效性形状展开为全 true 的 bool Tensor；这是已有有效性声明的等价表示，不是根据数值或姿态推测有效性。有效性必须为 bool Tensor，不能用 Python True 代替字段内的 Tensor。静态数值字段同样配套 valid，形状采用其语义定义的标量或逐元素有效性；静态网格等外部资产仍可在 metainfo 中声明标量 valid。

valid 的形状不要求与 data 完全相同，但必须与该字段定义一致。例如 MANO 为 [T,2,61] / [T,2]，内参为 [T,3,3] / [T]，关键点为 [T,2,K,3] / [T,2,K]。按 schema 将 valid 扩展到相应数值维度，不允许依靠碰巧可广播推断语义。

浮点默认 float32，无效浮点位置仍为 NaN；bool 和整数沿用该组件的占位/保留值规则，不因没有 NaN 而视为有效。valid 表达可用监督，不只是“值有限”或“记录存在”；适用官方 QA 与已经确认的排除规则继续保留。不能用 isfinite(data) 重建 valid，不能因为迁移而把 false 改成 true。

不同字段的 valid 独立保存和解释。visibility 的 valid 不复用姿态 valid；内参 valid 不代替外参 valid。既有相机模型要求内参与单独畸变向量共用有效性时，在两个字段内保存相同 bool 值并校验一致，而不改变该模型的联合标定规则。

4. 固定分组与字段名

下表中的键路径用 / 展示字典层级；它不是文件系统路径。数值字段均在列出的键下继续存储 data、valid。

文件	数值字段键	内容
`camera/camera.pt`	`intrinsic`、`extrinsic`、`distortion`	逐帧标定；形状、参数顺序与相机模型定义不变
`annotation/mano/mano.pt`	`motion`、`visibility`	MANO `[T,2,61]` 与源整手可见性；各有独立有效性
`annotation/keypoints/keypoints.pt`	`uv`、`xyz`、`visibility`、`whole_hand_visibility`	手关键点及源可见性；整手与逐点可见性不混用
`annotation/object/<id>/object.pt`	`pose`、`visibility`、`dimensions`、`joint_state`	该物体的数值标注
同上	`keypoints/xyz`、`keypoints/template_xyz`	相机系逐帧点或物体系静态模板点
同上	`parts/<part_id>/pose`、`parts/<part_id>/dimensions`、`parts/<part_id>/keypoints/xyz`、`parts/<part_id>/keypoints/template_xyz`	部件数值字段，部件身份仍由 articulation 登记
同上	`meshes/<mesh_id>/vertex_part_ids`	`[V] int64` 顶点部件标签，valid 为 `[V]`，未知 -1 对应 false；每个 mesh 单独绑定拓扑
`annotation/contact/<subject_id>__<object_id>/contact.pt`	`vertex_region`、`vertex_distance`	已登记拓扑上的接触区域/距离与同形有效性

顶点部件标签使用注册类型 object/vertex_part_ids/v1。物体的 mesh_id、part_id 必须在 metainfo/运动学定义中可解析；不同拓扑不能误用同一顶点数组。未提供的可见性、关节值或模板点不生成空字段。

媒体和 JSONL 的有效性保持原样，不参与字典合并：

数据本体	有效性文件	存储形式
`observation/rgb.mkv`	`observation/rgb_valid.pt`	独立 CPU bool Tensor `[T]`
`annotation/segment/mask.mkv` 或 `polygons.jsonl`	原 `valid_ref` 指定的文件，通常为 `annotation/segment/mask_valid.pt`	独立 CPU bool Tensor `[T]`；沿用原路径
`annotation/contact/relations.jsonl`	`annotation/contact/relations_valid.pt`	独立 CPU bool Tensor `[T]`
`observation/depth.mkv`	`observation/depth_valid.mkv`	原逐像素 bool 无损视频 `[T,H,W]`

不新建仅包装上述 valid 的 observation.pt、segment.pt 或关系级 contact.pt。现有媒体/JSONL 的 valid_ref、valid_axes 及适用的 valid_storage 保持原定义；深度编码、NaN 位串还原与像素有效性规则不变。实体对的接触区域/距离是数值张量，仍按上表合并到各实体对的 contact.pt。

5. metainfo 的文件与字典键引用

文件定位与字典内部定位分开登记，不在文件名中拼接自定义分隔符：

字段	定义
`data_ref`	相对当前相机视图根目录的 POSIX 文件路径
`data_key`	非空字符串列表，按顺序访问 `.pt` 嵌套字典，最终必须得到 data Tensor
`valid_ref`	有效性所在文件；合并的数值字段必须与 data_ref 相同，媒体/JSONL 保留独立有效性文件
`valid_key`	非空字符串列表，最终必须得到 bool Tensor
`storage.profile` / `valid_storage.profile`	合并字典采用 `pt/tensor_bundle/v1`；媒体及其独立有效性保持原配置，不将独立 bool Tensor 声明为 bundle

数值字段必须显式登记 data_key 与 valid_key。例如内参登记：

{
  "available": true,
  "schema_id": "camera/pinhole/v1",
  "data_ref": "camera/camera.pt",
  "data_key": ["intrinsic", "data"],
  "axes": ["T", "row", "column"],
  "valid_ref": "camera/camera.pt",
  "valid_key": ["intrinsic", "valid"],
  "valid_axes": ["T"],
  "storage": {"profile": "pt/tensor_bundle/v1"},
  "valid_storage": {"profile": "pt/tensor_bundle/v1"}
}

这是引用结构片段，实际组件仍须补齐 provenance、source_locator 等必填内容。MANO 的 schema_id 仍可为 mano/axis_angle61/v1：它描述解码后的数值语义，不因为物理文件合并而改动。顶层 schema_version 与 storage.profile 标识新的存储方式。

媒体和 JSONL 的 data_ref 不设置 data_key；RGB 的 valid_ref 仍为 observation/rgb_valid.pt，不设置 valid_key。分割、关系和深度的有效性同样保持原引用方式，不新增任何字典键字段。只有引用合并字典时才使用 data_key/valid_key。

同样规则适用于 attributes 中的可见性等数值字段。相机模型已有的 distortion_ref 改为指向 camera/camera.pt，新增 distortion_key=["distortion", "data"]；对应有效性由同组件的 distortion_valid_ref 与 distortion_valid_key=["distortion", "valid"] 登记。带 _key 的引用必须指向匹配的 bundle 文件，不能指向目录或媒体。

读取器按文件路径缓存已加载字典，再按 key 取字段。同一 camera.pt 的三个字段不应触发三次反序列化。按组件下载时取所需 bundle 的整个文件；本约定不承诺 .pt 内单个键的远端局部下载。组件合并会增加最小下载粒度，这是减少文件数的明确取舍。

6. 迁移与验收

各数据集分别迁移：先适配工具并做代表性完整序列验证，再迁移全量并核对结果，最后按授权更新远端发布；一个数据集完成不代表其他数据集已完成。迁移状态和输入/输出固定版本逐数据集登记。

本地先在既有 shared-v1.0 内完成受控升级，校验完成后更名为 shared-v1.1。暂存、回滚、锁、旧文件清理、版本更新及 HF 路径切换遵循 MIGRATION.md；不复制完整媒体、不改 raw、不重新编码。多文件原地更新期间须保持维护状态，不能让读取任务使用半迁移视图。

每次迁移必须检查：

所有组件、属性及其字典键可解析；无越界文件引用、缺失键或未登记字段；已合并的数值组件不得遗留旧独立 *_valid.pt。媒体/JSONL 的原独立有效性文件必须保留，不得误删或重打包。
每个迁移前后的数值字段 dtype、shape、逐元素值、NaN 位置以及 bool valid 完全一致。数值张量还应按统一连续字节视图比较，确认没有更改 NaN 位串等内容；不能用近似容差代替单纯重打包的一致性。
T、帧映射、相机方向、手槽、split、来源和 valid_policy 不变。固定标定仍按既有 [T,...] 规则保存；本次不额外改成单份静态标定加广播。
媒体与其他未修改文件按原可信摘要核对。新 .pt 的文件 SHA256 通常改变，必须重新生成发布清单；新文件指纹不等于转换语义正确性的证明。
用新读取器运行代表性完整序列及所有相机，检查 RGB、相机与实际存在的标注是否正确关联；报告明确“重打包数值一致”与“人工视觉验收”的不同范围。

只有完成匹配注册表、读写工具及上述验收后才能生产/发布 v1.1。上传仍须单独得到授权；本文档更新本身不启动数据迁移或上传；被替代旧文件的清理属于后续迁移发布步骤，必须遵守MIGRATION.md 中先验收、安全切换和固定提交核验要求。