Placement_Assets / docs /naming_spec.md
yuchi233's picture
Upload docs/naming_spec.md with huggingface_hub
7935452 verified
|
Raw
History Blame Contribute Delete
1.39 kB
# Asset Naming Specification
## Directory fields
```text
assets/<source>/raw/<asset_type>/<category>/<asset_id>/
```
Collection imports must still use the same four-level layout under `raw/`:
```text
assets/<source>/raw/<asset_type>/<category>/<asset_id>/
```
The upstream tree should be preserved inside that directory.
- `source`: lowercase snake_case.
- `asset_type`: lowercase snake_case plural for collections.
- `category`: lowercase snake_case.
- `asset_id`: preserve upstream IDs when stable.
Derived outputs use the same semantic fields, but live under:
```text
assets/<source>/derived/<asset_type>/<category>/<asset_id>/
```
Use a distinct `asset_id` suffix or additional `variant` field when storing generated variants such as convex decomposition.
Common derived `asset_type` values:
```text
convex_decompositions
primitive_collision_proxies
```
Example derived IDs:
```text
robocasa.convex_decompositions.dishwashers.Dishwasher031_coacd_v1
robocasa.primitive_collision_proxies.dishwashers.Dishwasher031_rack1_primitive_boxes_v1
```
## Global asset_id
Use:
```text
<source>.<asset_type>.<category>.<upstream_id>
```
Example:
```text
robocasa.fixtures.dishwashers.Dishwasher031
```
## Preservation rule
Do not rename upstream model files unless there is a compatibility reason. Prefer storing normalization metadata instead of mutating raw asset structure.