Upload README_zh.md with huggingface_hub

README_zh.md

@@ -0,0 +1,314 @@
+# Placement Assets 资产库
+
+这是一个面向机器人仿真与 placement 任务的统一资产库，当前托管在 Hugging Face Dataset：
+
+```text
+https://huggingface.co/datasets/yuchi233/Placement_Assets
+```
+
+本仓库不是 RoboCasa 的镜像，也不是基于 RoboCasa 单独建立的资产库。RoboCasa、DISCOVERSE、TinyForge、Hunter 和第三方资产站都被视为不同的资产来源，统一纳入同一套存储、命名、索引和溯源规范。
+
+## 当前已入库资产
+
+- RoboCasa 洗碗机 fixture：
+  - 路径：`assets/robocasa/fixtures/dishwashers/`
+  - 数量：25 个 MJCF 资产
+  - 每个资产保留 `model.xml`、`visuals/` 和本地 `metadata.yaml`
+- RoboCasa 洗碗机相关辅助文件：
+  - registry：`assets/robocasa/fixtures/fixture_registry/dishwasher.yaml`
+  - fixture 实现参考：`docs/source_notes/robocasa/dishwasher_fixture.py`
+- DISCOVERSE models 集合：
+  - 路径：`assets/discoverse/collections/models/discoverse_models/`
+  - 内容：MJCF、URDF、mesh、PNG/reference image 等
+  - 处理方式：作为 collection-level asset 入库，内部保持 DISCOVERSE upstream 的 `models/` 目录结构，避免破坏 MJCF include 和 mesh 相对路径
+
+## 统一目录结构
+
+所有可索引资产都必须使用四层结构：
+
+```text
+assets/<source>/<asset_type>/<category>/<asset_id>/
+```
+
+示例：
+
+```text
+assets/robocasa/fixtures/dishwashers/Dishwasher031/
+```
+
+大规模 upstream 资产树如果包含大量内部相对引用，也必须使用四层结构，但可作为集合资产保存：
+
+```text
+assets/<source>/collections/<category>/<asset_id>/
+```
+
+示例：
+
+```text
+assets/discoverse/collections/models/discoverse_models/
+├── metadata.yaml
+├── mjcf/
+├── meshes/
+└── urdf/
+```
+
+## 命名规则
+
+目录字段：
+
+```text
+assets/<source>/<asset_type>/<category>/<asset_id>/
+```
+
+- `source`：资产来源，使用小写 snake_case，例如 `robocasa`、`discoverse`、`tinyforge`、`hunter`、`third_party`
+- `asset_type`：资产类型，例如 `fixtures`、`objects`、`scenes`、`robots`、`collections`
+- `category`：类别，例如 `dishwashers`、`models`、`cups`、`cabinets`
+- `asset_id`：优先保留 upstream 稳定 ID，例如 `Dishwasher031`
+
+全局 asset_id：
+
+```text
+<source>.<asset_type>.<category>.<upstream_id>
+```
+
+示例：
+
+```text
+robocasa.fixtures.dishwashers.Dishwasher031
+discoverse.collections.models.discoverse_models
+```
+
+## 仓库结构
+
+```text
+.
+├── AGENTS.md                         # 给 agent / 后续维护者的仓库使用说明
+├── README.md                         # 英文 README
+├── README_zh.md                      # 中文 README
+├── assets/                           # 实际资产文件
+│   ├── discoverse/
+│   ├── hunter/
+│   ├── robocasa/
+│   ├── third_party/
+│   └── tinyforge/
+├── docs/                             # 规范、来源说明、调研记录
+│   ├── asset_readiness_classification.md
+│   ├── external_source_catalog.md
+│   ├── naming_spec.md
+│   ├── placement_asset_notes.md
+│   ├── structure_mapping.md
+│   ├── source_notes/
+│   └── storage_spec.md
+├── manifest/
+│   ├── assets.jsonl                  # 全局资产索引，一行一个资产
+│   ├── licenses.yaml                 # license 字典
+│   └── sources.yaml                  # 来源与候选第三方来源
+└── scripts/
+    ├── download_from_hf.sh
+    ├── upload_to_hf.sh
+    └── validate_asset.py
+```
+
+## 索引与 metadata
+
+全局索引文件：
+
+```text
+manifest/assets.jsonl
+```
+
+每个资产目录也必须包含：
+
+```text
+metadata.yaml
+```
+
+必需字段包括：
+
+- `asset_id`
+- `source`
+- `source_asset_id`
+- `asset_type`
+- `category`
+- `format`
+- `entry_file`
+- `license`
+- `origin_url`
+- `path`
+- `tags`
+
+推荐字段包括：
+
+- `readiness_level`
+- `source_commit`
+- `retrieval_date`
+- `conversion_tool`
+- `conversion_notes`
+- `raw_sha256`
+- `validation_status`
+
+## 原始结构与当前结构映射
+
+如果导入时修改了 upstream 的目录结构，必须记录原始结构和当前结构的对应关系。
+
+统一记录位置：
+
+```text
+docs/structure_mapping.md
+docs/source_notes/<source>.md
+```
+
+当前例子：
+
+```text
+DISCOVERSE upstream:
+  /home/yuchi/projects/DISCOVERSE/models/
+
+当前仓库:
+  assets/discoverse/collections/models/discoverse_models/
+```
+
+RoboCasa 洗碗机则是一对一映射：
+
+```text
+robocasa/models/assets/fixtures/dishwashers/Dishwasher031/
+→ assets/robocasa/fixtures/dishwashers/Dishwasher031/
+```
+
+## 资产就绪度 L0–L5
+
+资产存进仓库不代表可以直接用于产数。就绪度单独记录：
+
+- L0：已通过目标任务、机器人 embodiment、policy、verifier 和 episode replay 验收，可稳定产数
+- L1：在原仿真器中是完整���运行资产，但尚未适配目标产数链路
+- L2：已有 articulated 结构，但物理、碰撞、任务语义等信息不完整
+- L3：可动部件已分离，但缺少可靠 joint
+- L4：完整静态整件
+- L5：原始、缺件、未装配或需要显著修复的静态 mesh
+
+完整标准见：
+
+```text
+docs/asset_readiness_classification.md
+```
+
+当前状态：
+
+- RoboCasa dishwasher：`L1_candidate`
+- DISCOVERSE collection：`L1_L2_candidate_by_subasset`
+
+## 第三方资产规则
+
+第三方来源可以先只记录链接，不下载、不入 manifest。
+
+只有当某个项目、实验、任务或生成场景实际使用了第三方资产时，才把具体使用到的资产复制进本仓库：
+
+```text
+assets/third_party/<asset_type>/<category>/<asset_id>/
+```
+
+导入时必须记录：
+
+- 原始 URL
+- provider / site name
+- license
+- retrieval date
+- source asset ID
+- 本地路径
+- 转换或清洗步骤
+- 必要时记录 hash
+
+候选第三方来源见：
+
+```text
+docs/external_source_catalog.md
+docs/source_notes/third_party.md
+```
+
+重要规则：
+
+- link-only candidate 不写入 `manifest/assets.jsonl`
+- 下载数量不等于可生产资产数量
+- 来源库总量不能直接相加，必须处理上游派生和重复资产
+
+## 校验
+
+在仓库根目录运行：
+
+```bash
+python scripts/validate_asset.py --all
+```
+
+当前期望输出：
+
+```text
+validated_assets=26
+```
+
+也可以校验单个资产：
+
+```bash
+python scripts/validate_asset.py assets/robocasa/fixtures/dishwashers/Dishwasher031
+```
+
+校验内容包括：
+
+- `metadata.yaml` 是否存在
+- `entry_file` 是否存在
+- 资产目录是否符合四层结构
+- metadata 与目录字段是否一致
+- metadata 与 manifest 是否一致
+- MJCF 中的 mesh/texture 文件引用是否能解析
+
+## 下载
+
+```bash
+export HF_ENDPOINT=https://hf-mirror.com
+
+hf download yuchi233/Placement_Assets \
+  --repo-type dataset \
+  --local-dir ./Placement_Assets \
+  --max-workers 4
+```
+
+或使用脚本：
+
+```bash
+scripts/download_from_hf.sh yuchi233/Placement_Assets ./Placement_Assets
+```
+
+## 上传
+
+先登录：
+
+```bash
+export HF_ENDPOINT=https://hf-mirror.com
+hf auth login
+```
+
+上传：
+
+```bash
+cd /home/yuchi/asset-library
+scripts/upload_to_hf.sh yuchi233/Placement_Assets
+```
+
+或者直接使用：
+
+```bash
+hf upload yuchi233/Placement_Assets . . --repo-type dataset
+```
+
+## 后续扩展流程
+
+新增资产时按以下步骤：
+
+1. 确认来源、license、可再分发性和用途。
+2. 确定资产粒度：单资产还是 collection-level asset。
+3. 放入统一四层目录结构。
+4. 保留 upstream 文件名和相对路径，除非有兼容性原因。
+5. 添加 `metadata.yaml`。
+6. 更新 `manifest/assets.jsonl`。
+7. 如果改了目录结构，更新 `docs/structure_mapping.md` 和 `docs/source_notes/<source>.md`。
+8. 运行 `python scripts/validate_asset.py --all`。
+9. 上传到 Hugging Face。