yuchi233 commited on
Commit
a4eb37b
·
verified ·
1 Parent(s): 96ac0b2

Upload AGENTS.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. AGENTS.md +35 -1
AGENTS.md CHANGED
@@ -68,6 +68,40 @@ mjcf/convex_collision_include.xml # standalone wrapper for preview/convenience
68
 
69
  Do not edit the raw source `model.xml` when adding convex collision geometry. Integrate the derived includes in downstream task scenes or in separate derived MJCF files.
70
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
  Whenever a source is reorganized during import, record the original upstream layout and the current layout in:
72
 
73
  ```text
@@ -80,7 +114,7 @@ Do not change source paths without recording the correspondence.
80
  ## Naming rules
81
 
82
  - `source`: lowercase snake_case, for example `robocasa`, `discoverse`, `tinyforge`, `hunter`, `third_party`.
83
- - `asset_type`: lowercase snake_case plural when it represents a collection, for example `fixtures`, `objects`, `scenes`, `textures`, `robots`, `environments`.
84
  - `category`: lowercase snake_case, usually preserving common upstream category wording, for example `dishwashers`, `cabinets`, `cups`.
85
  - `asset_id`: preserve upstream IDs when they are stable and meaningful, for example `Dishwasher031`.
86
  - Global `asset_id`: `<source>.<asset_type>.<category>.<upstream_id>`.
 
68
 
69
  Do not edit the raw source `model.xml` when adding convex collision geometry. Integrate the derived includes in downstream task scenes or in separate derived MJCF files.
70
 
71
+ For thin rod, rack, grid, shelf, and slot-like structures where convex hulls may bridge functional gaps, prefer primitive collision proxies:
72
+
73
+ ```text
74
+ assets/<source>/derived/primitive_collision_proxies/<category>/<asset_id>_<variant>/
75
+ ```
76
+
77
+ Preferred generator:
78
+
79
+ ```bash
80
+ python scripts/run_primitive_collision_proxy.py assets/<source>/raw/<asset_type>/<category>/<asset_id> --mesh <relative_obj_path> --variant primitive_boxes_v1
81
+ ```
82
+
83
+ Primitive proxy source of truth:
84
+
85
+ ```text
86
+ proxy/primitive_collision_proxy.json
87
+ ```
88
+
89
+ Generated downstream fragments:
90
+
91
+ ```text
92
+ mjcf/primitive_geoms_include.xml # include inside the target body
93
+ mjcf/primitive_collision_include.xml # standalone wrapper for preview/convenience
94
+ curobo/primitive_world.yml # cuRobo cuboid fragment from forbidden cuboids
95
+ ```
96
+
97
+ Use primitive proxies only after inspecting that boxes do not bridge task-critical gaps. For temporary trials, do not use `--register-manifest`.
98
+
99
+ Detailed rules are in:
100
+
101
+ ```text
102
+ docs/primitive_collision_proxy_spec.md
103
+ ```
104
+
105
  Whenever a source is reorganized during import, record the original upstream layout and the current layout in:
106
 
107
  ```text
 
114
  ## Naming rules
115
 
116
  - `source`: lowercase snake_case, for example `robocasa`, `discoverse`, `tinyforge`, `hunter`, `third_party`.
117
+ - `asset_type`: lowercase snake_case plural when it represents a collection, for example `fixtures`, `objects`, `scenes`, `textures`, `robots`, `environments`, `convex_decompositions`, `primitive_collision_proxies`.
118
  - `category`: lowercase snake_case, usually preserving common upstream category wording, for example `dishwashers`, `cabinets`, `cups`.
119
  - `asset_id`: preserve upstream IDs when they are stable and meaningful, for example `Dishwasher031`.
120
  - Global `asset_id`: `<source>.<asset_type>.<category>.<upstream_id>`.