update readme files

holoboxing/README.md

@@ -1,5 +1,7 @@
 # HoloBoxing resources
 
+English | [简体中文](README.zh-CN.md)
+
 This directory contains the robot, arena and replay assets used by HoloBoxing.
 Keep the complete directory and its relative layout when distributing it.
 The frozen HoloMotion controller and competitor policies are separate model files.
@@ -44,8 +46,8 @@ The expected commands from the public HoloMotion checkout are:
 
 ```bash
 python -m holoboxing assets --assets /path/to/huggingface-resources
-python -m holoboxing validate upper.onnx --assets /path/to/huggingface-resources --lower /path/to/v2-bundle --output validation.json
-python -m holoboxing match red.onnx blue.onnx --assets /path/to/huggingface-resources --lower /path/to/v2-bundle --output-dir results
+python -m holoboxing validate my_policy.onnx --assets /path/to/huggingface-resources --lower /path/to/v2-bundle --output validation.json
+python -m holoboxing match my_policy.onnx opponent_policy.onnx --assets /path/to/huggingface-resources --lower /path/to/v2-bundle --output-dir results
 python -m holoboxing view results/replay.hdf5 --assets /path/to/huggingface-resources
 ```
 
@@ -72,7 +74,7 @@ The example below uses a local image tag; load or build that image first.
 docker run --rm --gpus '"device=0"' \
   -v /absolute/policies:/policies:ro \
   -v /absolute/results:/results \
-  holoboxing-eval:local-v8 match /policies/red.onnx /policies/blue.onnx \
+  holoboxing-eval:local-v8 match /policies/my_policy.onnx /policies/opponent_policy.onnx \
   --output-dir /results
 ```
 
@@ -94,3 +96,12 @@ Record the actual Hugging Face repository revision after uploading.
 
 Images may also be transferred using `docker save` and `docker load`.
 Keep the image digest, public code commit and resource/model revisions together.
+
+## Research and asset attribution
+
+Luo et al., [SMPLOlympics: Sports Environments for Physically Simulated Humanoids](https://arxiv.org/abs/2407.00187), 2024,
+is the source project for the boxing-ring mesh. This adaptation removes the
+stools, derives corner collisions, and changes the replay appearance.
+The competition uses its own G1 scene and scoring rules; using the ring does
+not reproduce SMPLOlympics' characters, policies, or benchmark results.
+Exact asset provenance and changes are recorded in [SOURCE.md](smpl-ring-v2/SOURCE.md).

holoboxing/README.zh-CN.md

@@ -0,0 +1,112 @@
+# HoloBoxing 资源
+
+[English](README.md) | 简体中文
+
+本目录包含 HoloBoxing 使用的机器人、擂台和回放资源。
+分发时须保留完整目录及其相对路径。
+冻结的 HoloMotion 控制器和参赛策略均为独立模型文件。
+
+## 目录内容与用途
+
+| 文件或目录 | 用途 | 来源与许可 |
+| --- | --- | --- |
+| `29dof/` | 红蓝双方的机器人描述：URDF 用于训练中的运动学计算，XML 用于回放 | 基于现有 G1 拳击版本；宇树原始许可声明见 `UNITREE_LICENSE`，修改部分仍需核实授权 |
+| `meshes/` | 机器人依赖的完整网格模型，保留仿真器使用的文件名 | 现有 G1 资源；文件内容的校验值记录在 `resources.json` 中 |
+| `mode15_boxing_meshes/` | 拳套及碰撞网格的变体 | 现有拳击修改资源；尚未确认再分发授权 |
+| `arena/g1_dual_29dof.xml` | 双机器人共用的物理场景 | 沿用现有拳击场景，刚体、关节和碰撞几何体保持不变 |
+| `smpl-ring-v2/` | 改编自 SMPLOlympics 的擂台、角柱碰撞描述、来源说明及上游许可 | 见[来源与署名](smpl-ring-v2/SOURCE.md) |
+| `dark-arena/` | 当前地面纹理，含 Horizon Robotics 和 HoloMotion 标识 | 现有纹理；授权仍需核实 |
+| `initial-state.json` | 拳击场景的初始姿态和具名关节顺序，不是用于回放的参考动作 | 仅保留初始帧 |
+| `resources.json` | 资源版本清单、字节数、SHA256 校验值和入口路径 | 本地完整性校验的依据 |
+| `manifest.json` | 现有回放播放器使用的机器人和文件条目 | 从同一资源目录生成 |
+
+当前资源版本为 `boxing-v5-resources`。
+`resources.json` 记录了每个资源文件的实际字节数和 SHA256 校验值。
+机器人 URDF/XML 和物理场景中的相对引用均须位于本目录内。
+物理场景入口仍为 `arena/g1_dual_29dof.xml`。
+
+旧版 `smpl-ring/` 已删除。
+旧文件 `arena/arena.xml`、`arena/scene.json` 和 `arena/canvas_texture.png` 也已删除。
+未带红蓝标记的旧文件 `29dof/g1_29dof_mode_15_boxing_gloves.urdf` 已移除。
+红蓝机器人描述及其 XML 显示入口仍保留。
+资源包不再包含旧路径。
+
+本目录支持当前的 `smplolympics-boxing-ring-v2` 回放场景。
+当前源码构建的独立评测播放器会拒绝旧版场景。
+历史演示录像和预览脚本可能仍需原版资源。
+
+擂台网格来自 SMPLOlympics。
+改编版本在 `smpl-ring-v2/` 中保留了上游署名和许可文本。
+原始网格作者及该资产的专门许可尚未确认，详见来源说明。
+完整性校验通过不代表已获得再分发权。
+宇树许可声明也不能覆盖所有修改、擂台和纹理。
+
+## 本地使用
+
+通过 `--assets /path/to/huggingface-resources` 显式指定本目录。
+评测工具和播放器不应从相邻仓库自动查找资源。
+在包含评测功能的公开 HoloMotion 仓库中执行：
+
+```bash
+python -m holoboxing assets --assets /path/to/huggingface-resources
+python -m holoboxing validate my_policy.onnx --assets /path/to/huggingface-resources --lower /path/to/v2-bundle --output validation.json
+python -m holoboxing match my_policy.onnx opponent_policy.onnx --assets /path/to/huggingface-resources --lower /path/to/v2-bundle --output-dir results
+python -m holoboxing view results/replay.hdf5 --assets /path/to/huggingface-resources
+```
+
+所用 HoloMotion 版本须包含 `holoboxing` 包和上述命令行入口。
+每次评测须同时记录代码版本和资源版本。
+冻结的 V2 模型权重单独存放，评测期间保持只读。
+从源码回放时，先构建一次浏览器播放器：
+
+```bash
+cd holoboxing/evaluation/viewer
+npm ci
+node build.mjs
+```
+
+先前构建的 v8 镜像内置 `boxing-v4-resources` 和冻结的 V2 控制器。
+当前本地目录已更新为 `boxing-v5-resources`。
+删除本地文件不会改变已有镜像。
+保留的物理场景和几何文件与 v4 逐字节一致。
+本次整理只删除旧资源，并补充来源署名。
+
+默认只需挂载参赛策略和输出目录。
+资源和控制器挂载用于替换镜像内置内容，均须保持只读。
+下例使用本地镜像标签，请先导入或构建该镜像。
+
+```bash
+docker run --rm --gpus '"device=0"' \
+  -v /absolute/policies:/policies:ro \
+  -v /absolute/results:/results \
+  holoboxing-eval:local-v8 match /policies/my_policy.onnx /policies/opponent_policy.onnx \
+  --output-dir /results
+```
+
+如需替换资源，将本目录以只读方式挂载到 `/assets`，并传入 `--assets /assets`。
+如需挂载其他已验证控制器，使用 `--lower /lower`。
+
+浏览器读取已保存的状态和事件，不重新运行物理仿真或策略推理。
+播放器保留播放、跳转、比分、事件标记和 MP4 导出功能。
+能否导出 MP4，取决于浏览器的 MediaRecorder 编解码支持。
+
+## 分发与来源记录
+
+资源文件保存在本地，普通 Git 默认忽略这些文件。
+元数据、许可声明和来源署名由 Git 管理。
+手动上传到 Hugging Face 时，须保留相同的相对目录结构。
+同时上传本 README 和两份资源清单。
+以资源目录中的内容作为上传仓库根目录。
+这样可在仓库根目录直接访问 `resources.json`。
+上传后记录实际的 Hugging Face 仓库版本。
+
+镜像也可通过 `docker save` 和 `docker load` 转移。
+请一并保留镜像摘要、公开代码提交和资源及模型版本。
+
+## 研究与资源来源
+
+擂台网格来自 Luo 等的 [SMPLOlympics: Sports Environments for Physically Simulated Humanoids](https://arxiv.org/abs/2407.00187)，2024。
+本适配移除了凳子，提取角柱碰撞几何，并调整回放外观。
+比赛使用自己的 G1 场景和计分规则。
+复用擂台不代表复现了该项目的角色、策略或基准结果。
+精确来源和修改记录见 [SOURCE.md](smpl-ring-v2/SOURCE.md)。