Upload folder using huggingface_hub
Browse files- docs/asset_readiness_classification.md +2 -2
- docs/convex_decomposition_spec.md +135 -0
- docs/naming_spec.md +11 -3
- docs/placement_asset_notes.md +14 -14
- docs/source_notes/discoverse.md +5 -5
- docs/source_notes/robocasa.md +4 -4
- docs/source_notes/third_party.md +1 -1
- docs/storage_spec.md +21 -4
- docs/structure_mapping.md +12 -0
docs/asset_readiness_classification.md
CHANGED
|
@@ -33,8 +33,8 @@ Readiness must be evaluated against a target task, robot embodiment, simulator,
|
|
| 33 |
|
| 34 |
| Source | Stored asset group | Current technical level | Notes |
|
| 35 |
| --- | --- | --- | --- |
|
| 36 |
-
| RoboCasa | `assets/robocasa/fixtures/dishwashers/` | L1 candidate | Complete MJCF dishwasher fixtures used by RoboCasa/robosuite. Still needs downstream task/policy-specific L0 validation. |
|
| 37 |
-
| DISCOVERSE | `assets/discoverse/collections/models/discoverse_models/` | L1/L2 candidate by subasset | Preserved upstream `models/` tree. Some files are complete task environments; individual MJCF/URDF assets should be promoted individually after task-specific validation. |
|
| 38 |
| TinyForge | link-only placeholder | not classified | No physical asset imported yet. |
|
| 39 |
| Hunter | link-only placeholder | not classified | No physical asset imported yet. |
|
| 40 |
| Third-party sites | link-only candidates | not classified | Import only exact used assets after license/provenance review. |
|
|
|
|
| 33 |
|
| 34 |
| Source | Stored asset group | Current technical level | Notes |
|
| 35 |
| --- | --- | --- | --- |
|
| 36 |
+
| RoboCasa | `assets/robocasa/raw/fixtures/dishwashers/` | L1 candidate | Complete MJCF dishwasher fixtures used by RoboCasa/robosuite. Still needs downstream task/policy-specific L0 validation. |
|
| 37 |
+
| DISCOVERSE | `assets/discoverse/raw/collections/models/discoverse_models/` | L1/L2 candidate by subasset | Preserved upstream `models/` tree. Some files are complete task environments; individual MJCF/URDF assets should be promoted individually after task-specific validation. |
|
| 38 |
| TinyForge | link-only placeholder | not classified | No physical asset imported yet. |
|
| 39 |
| Hunter | link-only placeholder | not classified | No physical asset imported yet. |
|
| 40 |
| Third-party sites | link-only candidates | not classified | Import only exact used assets after license/provenance review. |
|
docs/convex_decomposition_spec.md
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Convex Decomposition Storage Specification
|
| 2 |
+
|
| 3 |
+
Convex decomposition outputs are derived assets. They must not overwrite raw meshes or upstream XML files.
|
| 4 |
+
|
| 5 |
+
## Path layout
|
| 6 |
+
|
| 7 |
+
Store convex decomposition results under:
|
| 8 |
+
|
| 9 |
+
```text
|
| 10 |
+
assets/<source>/derived/convex_decompositions/<category>/<asset_id>/
|
| 11 |
+
```
|
| 12 |
+
|
| 13 |
+
Example for a RoboCasa dishwasher:
|
| 14 |
+
|
| 15 |
+
```text
|
| 16 |
+
assets/robocasa/derived/convex_decompositions/dishwashers/Dishwasher031_vhacd_v1/
|
| 17 |
+
├── metadata.yaml
|
| 18 |
+
├── source_refs.yaml
|
| 19 |
+
├── meshes/
|
| 20 |
+
│ ├── door/
|
| 21 |
+
│ │ ├── part_000.obj
|
| 22 |
+
│ │ ├── part_001.obj
|
| 23 |
+
│ │ └── ...
|
| 24 |
+
│ ├── rack0/
|
| 25 |
+
│ └── rack1/
|
| 26 |
+
├── mjcf/
|
| 27 |
+
│ └── convex_collision_include.xml
|
| 28 |
+
└── logs/
|
| 29 |
+
└── decomposition.json
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
Example for a DISCOVERSE object:
|
| 33 |
+
|
| 34 |
+
```text
|
| 35 |
+
assets/discoverse/derived/convex_decompositions/objects/cup_vhacd_v1/
|
| 36 |
+
├── metadata.yaml
|
| 37 |
+
├── source_refs.yaml
|
| 38 |
+
├── meshes/
|
| 39 |
+
│ └── cup/
|
| 40 |
+
│ ├── part_000.obj
|
| 41 |
+
│ └── part_001.obj
|
| 42 |
+
├── mjcf/
|
| 43 |
+
│ └── convex_collision_include.xml
|
| 44 |
+
└── logs/
|
| 45 |
+
└── decomposition.json
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
## Required files
|
| 49 |
+
|
| 50 |
+
### `metadata.yaml`
|
| 51 |
+
|
| 52 |
+
Minimum fields:
|
| 53 |
+
|
| 54 |
+
```yaml
|
| 55 |
+
asset_id: robocasa.convex_decompositions.dishwashers.Dishwasher031_vhacd_v1
|
| 56 |
+
source: robocasa
|
| 57 |
+
asset_type: convex_decompositions
|
| 58 |
+
category: dishwashers
|
| 59 |
+
source_asset_id: Dishwasher031
|
| 60 |
+
format: obj_mjcf_include
|
| 61 |
+
entry_file: mjcf/convex_collision_include.xml
|
| 62 |
+
license: CC-BY-4.0
|
| 63 |
+
origin_url: https://robocasa.ai
|
| 64 |
+
path: assets/robocasa/derived/convex_decompositions/dishwashers/Dishwasher031_vhacd_v1
|
| 65 |
+
storage_mode: derived
|
| 66 |
+
derived_from:
|
| 67 |
+
- assets/robocasa/raw/fixtures/dishwashers/Dishwasher031
|
| 68 |
+
derivation_method: convex_decomposition
|
| 69 |
+
decomposition_tool: vhacd
|
| 70 |
+
decomposition_version: TBD
|
| 71 |
+
decomposition_params_file: logs/decomposition.json
|
| 72 |
+
validation_status: pending
|
| 73 |
+
tags:
|
| 74 |
+
- robocasa
|
| 75 |
+
- convex_decomposition
|
| 76 |
+
- collision
|
| 77 |
+
- mujoco
|
| 78 |
+
```
|
| 79 |
+
|
| 80 |
+
### `source_refs.yaml`
|
| 81 |
+
|
| 82 |
+
Record exact source files:
|
| 83 |
+
|
| 84 |
+
```yaml
|
| 85 |
+
raw_asset: assets/robocasa/raw/fixtures/dishwashers/Dishwasher031
|
| 86 |
+
raw_entry_file: assets/robocasa/raw/fixtures/dishwashers/Dishwasher031/model.xml
|
| 87 |
+
raw_meshes:
|
| 88 |
+
- assets/robocasa/raw/fixtures/dishwashers/Dishwasher031/visuals/door.obj
|
| 89 |
+
- assets/robocasa/raw/fixtures/dishwashers/Dishwasher031/visuals/rack0.obj
|
| 90 |
+
```
|
| 91 |
+
|
| 92 |
+
### `logs/decomposition.json`
|
| 93 |
+
|
| 94 |
+
Record tool parameters and hashes:
|
| 95 |
+
|
| 96 |
+
```json
|
| 97 |
+
{
|
| 98 |
+
"tool": "vhacd",
|
| 99 |
+
"tool_version": "TBD",
|
| 100 |
+
"created_at": "YYYY-MM-DD",
|
| 101 |
+
"params": {},
|
| 102 |
+
"inputs": [
|
| 103 |
+
{
|
| 104 |
+
"path": "assets/robocasa/raw/fixtures/dishwashers/Dishwasher031/visuals/door.obj",
|
| 105 |
+
"sha256": "TBD"
|
| 106 |
+
}
|
| 107 |
+
],
|
| 108 |
+
"outputs": [
|
| 109 |
+
{
|
| 110 |
+
"path": "meshes/door/part_000.obj",
|
| 111 |
+
"sha256": "TBD"
|
| 112 |
+
}
|
| 113 |
+
]
|
| 114 |
+
}
|
| 115 |
+
```
|
| 116 |
+
|
| 117 |
+
## MJCF integration rule
|
| 118 |
+
|
| 119 |
+
Do not edit raw `model.xml` in place. If MuJoCo collision integration is needed, write a generated include file under:
|
| 120 |
+
|
| 121 |
+
```text
|
| 122 |
+
mjcf/convex_collision_include.xml
|
| 123 |
+
```
|
| 124 |
+
|
| 125 |
+
Downstream projects can include or compile this file when they want convex collision geometry.
|
| 126 |
+
|
| 127 |
+
## Manifest rule
|
| 128 |
+
|
| 129 |
+
Convex decomposition results are real derived assets and must be indexed in:
|
| 130 |
+
|
| 131 |
+
```text
|
| 132 |
+
manifest/assets.jsonl
|
| 133 |
+
```
|
| 134 |
+
|
| 135 |
+
Link-only plans or empty placeholders should not be listed in the manifest.
|
docs/naming_spec.md
CHANGED
|
@@ -3,13 +3,13 @@
|
|
| 3 |
## Directory fields
|
| 4 |
|
| 5 |
```text
|
| 6 |
-
assets/<source>/<asset_type>/<category>/<asset_id>/
|
| 7 |
```
|
| 8 |
|
| 9 |
-
Collection imports must still use the same four-level layout:
|
| 10 |
|
| 11 |
```text
|
| 12 |
-
assets/<source>/
|
| 13 |
```
|
| 14 |
|
| 15 |
The upstream tree should be preserved inside that directory.
|
|
@@ -19,6 +19,14 @@ The upstream tree should be preserved inside that directory.
|
|
| 19 |
- `category`: lowercase snake_case.
|
| 20 |
- `asset_id`: preserve upstream IDs when stable.
|
| 21 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 22 |
## Global asset_id
|
| 23 |
|
| 24 |
Use:
|
|
|
|
| 3 |
## Directory fields
|
| 4 |
|
| 5 |
```text
|
| 6 |
+
assets/<source>/raw/<asset_type>/<category>/<asset_id>/
|
| 7 |
```
|
| 8 |
|
| 9 |
+
Collection imports must still use the same four-level layout under `raw/`:
|
| 10 |
|
| 11 |
```text
|
| 12 |
+
assets/<source>/raw/<asset_type>/<category>/<asset_id>/
|
| 13 |
```
|
| 14 |
|
| 15 |
The upstream tree should be preserved inside that directory.
|
|
|
|
| 19 |
- `category`: lowercase snake_case.
|
| 20 |
- `asset_id`: preserve upstream IDs when stable.
|
| 21 |
|
| 22 |
+
Derived outputs use the same semantic fields, but live under:
|
| 23 |
+
|
| 24 |
+
```text
|
| 25 |
+
assets/<source>/derived/<asset_type>/<category>/<asset_id>/
|
| 26 |
+
```
|
| 27 |
+
|
| 28 |
+
Use a distinct `asset_id` suffix or additional `variant` field when storing generated variants such as convex decomposition.
|
| 29 |
+
|
| 30 |
## Global asset_id
|
| 31 |
|
| 32 |
Use:
|
docs/placement_asset_notes.md
CHANGED
|
@@ -20,8 +20,8 @@ docs/structure_mapping.md
|
|
| 20 |
RoboCasa currently contributes dishwasher fixtures:
|
| 21 |
|
| 22 |
```text
|
| 23 |
-
assets/robocasa/fixtures/dishwashers/
|
| 24 |
-
assets/robocasa/fixtures/fixture_registry/dishwasher.yaml
|
| 25 |
```
|
| 26 |
|
| 27 |
These are useful for placement tasks involving loading dishes or objects into a dishwasher.
|
|
@@ -31,7 +31,7 @@ These are useful for placement tasks involving loading dishes or objects into a
|
|
| 31 |
DISCOVERSE is imported as a collection-level asset:
|
| 32 |
|
| 33 |
```text
|
| 34 |
-
assets/discoverse/collections/models/discoverse_models/
|
| 35 |
├── mjcf/
|
| 36 |
├── meshes/
|
| 37 |
└── urdf/
|
|
@@ -40,21 +40,21 @@ assets/discoverse/collections/models/discoverse_models/
|
|
| 40 |
Placement-relevant DISCOVERSE MJCF task/environment files include:
|
| 41 |
|
| 42 |
```text
|
| 43 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/task_environments/place_block.xml
|
| 44 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/task_environments/place_coffeecup.xml
|
| 45 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/task_environments/place_jujube.xml
|
| 46 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/task_environments/place_jujube_coffeecup.xml
|
| 47 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/task_environments/place_kiwi_fruit.xml
|
| 48 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/task_environments/place_spoon.xml
|
| 49 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/task_environments/coffeecup_plate.xml
|
| 50 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/task_environments/stack_block.xml
|
| 51 |
```
|
| 52 |
|
| 53 |
Placement-relevant DISCOVERSE object assets include bowls, plates, cups, fruit, boxes, baskets, pans, spoons, towels, trashbins, and cabinets under:
|
| 54 |
|
| 55 |
```text
|
| 56 |
-
assets/discoverse/collections/models/discoverse_models/mjcf/object/
|
| 57 |
-
assets/discoverse/collections/models/discoverse_models/meshes/object/
|
| 58 |
```
|
| 59 |
|
| 60 |
## Candidate external sources
|
|
@@ -68,7 +68,7 @@ The following sources are recorded as link-only candidates. Do not copy assets f
|
|
| 68 |
| Objaverse / Objaverse-XL | https://objaverse.allenai.org | Large-scale everyday objects for object placement and scene variety | Import exact used asset IDs with original UID, license, source URL, and conversion pipeline. |
|
| 69 |
| Google Scanned Objects | https://app.ignitionrobotics.org/GoogleResearch/fuel/collections/Google%20Scanned%20Objects | Scanned household objects suitable for manipulation and placement | Import exact used model with provider URL and license metadata. |
|
| 70 |
| RoboCasa | https://robocasa.ai | Kitchen fixtures, objects, scenes, textures, and placement-style tasks | Import normalized assets under `assets/robocasa/...`. |
|
| 71 |
-
| DISCOVERSE | https://github.com/discoverse-dev/DISCOVERSE | MJCF task environments, manipulation objects, robots, and scenes | Already imported as `assets/discoverse/collections/models/discoverse_models/`. |
|
| 72 |
|
| 73 |
## Third-party intake checklist
|
| 74 |
|
|
|
|
| 20 |
RoboCasa currently contributes dishwasher fixtures:
|
| 21 |
|
| 22 |
```text
|
| 23 |
+
assets/robocasa/raw/fixtures/dishwashers/
|
| 24 |
+
assets/robocasa/raw/fixtures/fixture_registry/dishwasher.yaml
|
| 25 |
```
|
| 26 |
|
| 27 |
These are useful for placement tasks involving loading dishes or objects into a dishwasher.
|
|
|
|
| 31 |
DISCOVERSE is imported as a collection-level asset:
|
| 32 |
|
| 33 |
```text
|
| 34 |
+
assets/discoverse/raw/collections/models/discoverse_models/
|
| 35 |
├── mjcf/
|
| 36 |
├── meshes/
|
| 37 |
└── urdf/
|
|
|
|
| 40 |
Placement-relevant DISCOVERSE MJCF task/environment files include:
|
| 41 |
|
| 42 |
```text
|
| 43 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/task_environments/place_block.xml
|
| 44 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/task_environments/place_coffeecup.xml
|
| 45 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/task_environments/place_jujube.xml
|
| 46 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/task_environments/place_jujube_coffeecup.xml
|
| 47 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/task_environments/place_kiwi_fruit.xml
|
| 48 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/task_environments/place_spoon.xml
|
| 49 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/task_environments/coffeecup_plate.xml
|
| 50 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/task_environments/stack_block.xml
|
| 51 |
```
|
| 52 |
|
| 53 |
Placement-relevant DISCOVERSE object assets include bowls, plates, cups, fruit, boxes, baskets, pans, spoons, towels, trashbins, and cabinets under:
|
| 54 |
|
| 55 |
```text
|
| 56 |
+
assets/discoverse/raw/collections/models/discoverse_models/mjcf/object/
|
| 57 |
+
assets/discoverse/raw/collections/models/discoverse_models/meshes/object/
|
| 58 |
```
|
| 59 |
|
| 60 |
## Candidate external sources
|
|
|
|
| 68 |
| Objaverse / Objaverse-XL | https://objaverse.allenai.org | Large-scale everyday objects for object placement and scene variety | Import exact used asset IDs with original UID, license, source URL, and conversion pipeline. |
|
| 69 |
| Google Scanned Objects | https://app.ignitionrobotics.org/GoogleResearch/fuel/collections/Google%20Scanned%20Objects | Scanned household objects suitable for manipulation and placement | Import exact used model with provider URL and license metadata. |
|
| 70 |
| RoboCasa | https://robocasa.ai | Kitchen fixtures, objects, scenes, textures, and placement-style tasks | Import normalized assets under `assets/robocasa/...`. |
|
| 71 |
+
| DISCOVERSE | https://github.com/discoverse-dev/DISCOVERSE | MJCF task environments, manipulation objects, robots, and scenes | Already imported as `assets/discoverse/raw/collections/models/discoverse_models/`. |
|
| 72 |
|
| 73 |
## Third-party intake checklist
|
| 74 |
|
docs/source_notes/discoverse.md
CHANGED
|
@@ -10,7 +10,7 @@ Imported from local clone:
|
|
| 10 |
|
| 11 |
```text
|
| 12 |
upstream: DISCOVERSE/models/
|
| 13 |
-
current : assets/discoverse/collections/models/discoverse_models/
|
| 14 |
├── mjcf/
|
| 15 |
├── meshes/
|
| 16 |
└── urdf/
|
|
@@ -22,10 +22,10 @@ This source is stored as a collection-level asset rather than splitting every XM
|
|
| 22 |
|
| 23 |
| Upstream | Current | Notes |
|
| 24 |
| --- | --- | --- |
|
| 25 |
-
| `models/mjcf/` | `assets/discoverse/collections/models/discoverse_models/mjcf/` | Preserved unchanged. MJCF include/file paths remain relative. |
|
| 26 |
-
| `models/meshes/` | `assets/discoverse/collections/models/discoverse_models/meshes/` | Preserved unchanged. Mesh references stay valid. |
|
| 27 |
-
| `models/urdf/` | `assets/discoverse/collections/models/discoverse_models/urdf/` | Preserved unchanged. |
|
| 28 |
-
| `models/metadata.yaml` | `assets/discoverse/collections/models/discoverse_models/metadata.yaml` | Added locally for indexing. |
|
| 29 |
|
| 30 |
Reference preservation: yes. The directory tree was wrapped in one collection asset, but no inner filenames were renamed.
|
| 31 |
|
|
|
|
| 10 |
|
| 11 |
```text
|
| 12 |
upstream: DISCOVERSE/models/
|
| 13 |
+
current : assets/discoverse/raw/collections/models/discoverse_models/
|
| 14 |
├── mjcf/
|
| 15 |
├── meshes/
|
| 16 |
└── urdf/
|
|
|
|
| 22 |
|
| 23 |
| Upstream | Current | Notes |
|
| 24 |
| --- | --- | --- |
|
| 25 |
+
| `models/mjcf/` | `assets/discoverse/raw/collections/models/discoverse_models/mjcf/` | Preserved unchanged. MJCF include/file paths remain relative. |
|
| 26 |
+
| `models/meshes/` | `assets/discoverse/raw/collections/models/discoverse_models/meshes/` | Preserved unchanged. Mesh references stay valid. |
|
| 27 |
+
| `models/urdf/` | `assets/discoverse/raw/collections/models/discoverse_models/urdf/` | Preserved unchanged. |
|
| 28 |
+
| `models/metadata.yaml` | `assets/discoverse/raw/collections/models/discoverse_models/metadata.yaml` | Added locally for indexing. |
|
| 29 |
|
| 30 |
Reference preservation: yes. The directory tree was wrapped in one collection asset, but no inner filenames were renamed.
|
| 31 |
|
docs/source_notes/robocasa.md
CHANGED
|
@@ -30,21 +30,21 @@ robocasa/models/assets/
|
|
| 30 |
This library currently includes RoboCasa dishwasher fixtures under:
|
| 31 |
|
| 32 |
```text
|
| 33 |
-
assets/robocasa/fixtures/dishwashers/
|
| 34 |
```
|
| 35 |
|
| 36 |
Included dishwasher-related files:
|
| 37 |
|
| 38 |
- 25 dishwasher fixture model directories: `Dishwasher031`, `Dishwasher032`, `Dishwasher034`, `Dishwasher036`, `Dishwasher038`, `Dishwasher039`, `Dishwasher040`, `Dishwasher042`, `Dishwasher043`, `Dishwasher044`, `Dishwasher045`, `Dishwasher046`, `Dishwasher048`, `Dishwasher049`, `Dishwasher051`, `Dishwasher053`, `Dishwasher054`, `Dishwasher055`, `Dishwasher058`, `Dishwasher059`, `Dishwasher060`, `Dishwasher061`, `Dishwasher062`, `Dishwasher063`, `Dishwasher067`
|
| 39 |
-
- Fixture registry: `assets/robocasa/fixtures/fixture_registry/dishwasher.yaml`
|
| 40 |
- Fixture implementation reference: `docs/source_notes/robocasa/dishwasher_fixture.py`
|
| 41 |
|
| 42 |
## Structure mapping
|
| 43 |
|
| 44 |
| Upstream | Current | Notes |
|
| 45 |
| --- | --- | --- |
|
| 46 |
-
| `robocasa/models/assets/fixtures/dishwashers/Dishwasher031/` | `assets/robocasa/fixtures/dishwashers/Dishwasher031/` | One-to-one directory mapping for each dishwasher model. `model.xml` and `visuals/` kept intact. |
|
| 47 |
-
| `robocasa/models/assets/fixtures/fixture_registry/dishwasher.yaml` | `assets/robocasa/fixtures/fixture_registry/dishwasher.yaml` | Registry copied without renaming. |
|
| 48 |
| `robocasa/models/fixtures/dishwasher.py` | `docs/source_notes/robocasa/dishwasher_fixture.py` | Reference copy for implementation and naming conventions. |
|
| 49 |
|
| 50 |
Reference preservation: yes. The assets were normalized into the unified library layout, but per-asset filenames and relative mesh references were preserved.
|
|
|
|
| 30 |
This library currently includes RoboCasa dishwasher fixtures under:
|
| 31 |
|
| 32 |
```text
|
| 33 |
+
assets/robocasa/raw/fixtures/dishwashers/
|
| 34 |
```
|
| 35 |
|
| 36 |
Included dishwasher-related files:
|
| 37 |
|
| 38 |
- 25 dishwasher fixture model directories: `Dishwasher031`, `Dishwasher032`, `Dishwasher034`, `Dishwasher036`, `Dishwasher038`, `Dishwasher039`, `Dishwasher040`, `Dishwasher042`, `Dishwasher043`, `Dishwasher044`, `Dishwasher045`, `Dishwasher046`, `Dishwasher048`, `Dishwasher049`, `Dishwasher051`, `Dishwasher053`, `Dishwasher054`, `Dishwasher055`, `Dishwasher058`, `Dishwasher059`, `Dishwasher060`, `Dishwasher061`, `Dishwasher062`, `Dishwasher063`, `Dishwasher067`
|
| 39 |
+
- Fixture registry: `assets/robocasa/raw/fixtures/fixture_registry/dishwasher.yaml`
|
| 40 |
- Fixture implementation reference: `docs/source_notes/robocasa/dishwasher_fixture.py`
|
| 41 |
|
| 42 |
## Structure mapping
|
| 43 |
|
| 44 |
| Upstream | Current | Notes |
|
| 45 |
| --- | --- | --- |
|
| 46 |
+
| `robocasa/models/assets/fixtures/dishwashers/Dishwasher031/` | `assets/robocasa/raw/fixtures/dishwashers/Dishwasher031/` | One-to-one directory mapping for each dishwasher model. `model.xml` and `visuals/` kept intact. |
|
| 47 |
+
| `robocasa/models/assets/fixtures/fixture_registry/dishwasher.yaml` | `assets/robocasa/raw/fixtures/fixture_registry/dishwasher.yaml` | Registry copied without renaming. |
|
| 48 |
| `robocasa/models/fixtures/dishwasher.py` | `docs/source_notes/robocasa/dishwasher_fixture.py` | Reference copy for implementation and naming conventions. |
|
| 49 |
|
| 50 |
Reference preservation: yes. The assets were normalized into the unified library layout, but per-asset filenames and relative mesh references were preserved.
|
docs/source_notes/third_party.md
CHANGED
|
@@ -25,5 +25,5 @@ Required metadata:
|
|
| 25 |
Use:
|
| 26 |
|
| 27 |
```text
|
| 28 |
-
assets/third_party/<asset_type>/<category>/<asset_id>/
|
| 29 |
```
|
|
|
|
| 25 |
Use:
|
| 26 |
|
| 27 |
```text
|
| 28 |
+
assets/third_party/raw/<asset_type>/<category>/<asset_id>/
|
| 29 |
```
|
docs/storage_spec.md
CHANGED
|
@@ -3,13 +3,13 @@
|
|
| 3 |
## Canonical path
|
| 4 |
|
| 5 |
```text
|
| 6 |
-
assets/<source>/<asset_type>/<category>/<asset_id>/
|
| 7 |
```
|
| 8 |
|
| 9 |
For large upstream trees that rely on many relative references, use the same four-level layout and store the upstream tree inside the collection asset directory:
|
| 10 |
|
| 11 |
```text
|
| 12 |
-
assets/<source>/
|
| 13 |
```
|
| 14 |
|
| 15 |
In that case, keep the upstream directory layout intact inside the collection directory and index the collection with a root `metadata.yaml`.
|
|
@@ -17,13 +17,30 @@ In that case, keep the upstream directory layout intact inside the collection di
|
|
| 17 |
Example:
|
| 18 |
|
| 19 |
```text
|
| 20 |
-
assets/discoverse/collections/models/discoverse_models/
|
| 21 |
├── metadata.yaml
|
| 22 |
├── mjcf/
|
| 23 |
├── meshes/
|
| 24 |
└── urdf/
|
| 25 |
```
|
| 26 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 27 |
## Required per-asset files
|
| 28 |
|
| 29 |
- Source asset files, preserving upstream structure where practical.
|
|
@@ -58,7 +75,7 @@ For MuJoCo/MJCF assets:
|
|
| 58 |
Example:
|
| 59 |
|
| 60 |
```text
|
| 61 |
-
assets/robocasa/fixtures/dishwashers/Dishwasher031/
|
| 62 |
├── metadata.yaml
|
| 63 |
├── model.xml
|
| 64 |
└── visuals/
|
|
|
|
| 3 |
## Canonical path
|
| 4 |
|
| 5 |
```text
|
| 6 |
+
assets/<source>/raw/<asset_type>/<category>/<asset_id>/
|
| 7 |
```
|
| 8 |
|
| 9 |
For large upstream trees that rely on many relative references, use the same four-level layout and store the upstream tree inside the collection asset directory:
|
| 10 |
|
| 11 |
```text
|
| 12 |
+
assets/<source>/raw/<asset_type>/<category>/<asset_id>/
|
| 13 |
```
|
| 14 |
|
| 15 |
In that case, keep the upstream directory layout intact inside the collection directory and index the collection with a root `metadata.yaml`.
|
|
|
|
| 17 |
Example:
|
| 18 |
|
| 19 |
```text
|
| 20 |
+
assets/discoverse/raw/collections/models/discoverse_models/
|
| 21 |
├── metadata.yaml
|
| 22 |
├── mjcf/
|
| 23 |
├── meshes/
|
| 24 |
└── urdf/
|
| 25 |
```
|
| 26 |
|
| 27 |
+
## Derived assets
|
| 28 |
+
|
| 29 |
+
Generated or transformed outputs must not overwrite raw assets. Store them under:
|
| 30 |
+
|
| 31 |
+
```text
|
| 32 |
+
assets/<source>/derived/<asset_type>/<category>/<asset_id>/
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
Use this for:
|
| 36 |
+
|
| 37 |
+
- convex decomposition results
|
| 38 |
+
- collision-only meshes
|
| 39 |
+
- format conversions
|
| 40 |
+
- normalized or cleaned variants
|
| 41 |
+
|
| 42 |
+
If a derived asset keeps a direct dependency on a raw asset, reference the raw asset in metadata and preserve provenance links.
|
| 43 |
+
|
| 44 |
## Required per-asset files
|
| 45 |
|
| 46 |
- Source asset files, preserving upstream structure where practical.
|
|
|
|
| 75 |
Example:
|
| 76 |
|
| 77 |
```text
|
| 78 |
+
assets/robocasa/raw/fixtures/dishwashers/Dishwasher031/
|
| 79 |
├── metadata.yaml
|
| 80 |
├── model.xml
|
| 81 |
└── visuals/
|
docs/structure_mapping.md
CHANGED
|
@@ -33,3 +33,15 @@ If you change a source’s on-disk structure, update:
|
|
| 33 |
- `docs/source_notes/<source>.md`
|
| 34 |
- the source’s `metadata.yaml`
|
| 35 |
- any manifest row that stores `path`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
- `docs/source_notes/<source>.md`
|
| 34 |
- the source’s `metadata.yaml`
|
| 35 |
- any manifest row that stores `path`
|
| 36 |
+
|
| 37 |
+
## Current storage layers
|
| 38 |
+
|
| 39 |
+
```text
|
| 40 |
+
assets/<source>/raw/...
|
| 41 |
+
assets/<source>/derived/...
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
- `raw/`: source-preserved imported files. Do not overwrite these during processing.
|
| 45 |
+
- `derived/`: generated or transformed outputs such as convex decomposition results, collision meshes, cleaned meshes, and format conversions.
|
| 46 |
+
|
| 47 |
+
Derived outputs must point back to their raw inputs through `metadata.yaml` and `source_refs.yaml`.
|