Upload AGENTS.md with huggingface_hub
Browse files
AGENTS.md
CHANGED
|
@@ -19,25 +19,33 @@ RoboCasa is one source inside this library, not the root format for the whole li
|
|
| 19 |
Use this canonical layout:
|
| 20 |
|
| 21 |
```text
|
| 22 |
-
assets/<source>/<asset_type>/<category>/<asset_id>/
|
| 23 |
```
|
| 24 |
|
| 25 |
Example:
|
| 26 |
|
| 27 |
```text
|
| 28 |
-
assets/robocasa/fixtures/dishwashers/Dishwasher031/
|
| 29 |
```
|
| 30 |
|
| 31 |
Each asset directory must contain the source asset files and a `metadata.yaml`.
|
| 32 |
|
| 33 |
-
For large upstream asset trees with many internal relative references, still use the canonical four-level layout and index the tree as one collection-level asset. Current example:
|
| 34 |
|
| 35 |
```text
|
| 36 |
-
assets/discoverse/collections/models/discoverse_models/
|
| 37 |
```
|
| 38 |
|
| 39 |
This avoids breaking MJCF includes and mesh paths.
|
| 40 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 41 |
Whenever a source is reorganized during import, record the original upstream layout and the current layout in:
|
| 42 |
|
| 43 |
```text
|
|
@@ -92,7 +100,7 @@ docs/asset_readiness_classification.md
|
|
| 92 |
If any external third-party asset is used by a project, experiment, dataset, or generated scene, copy that exact used asset into this repository under:
|
| 93 |
|
| 94 |
```text
|
| 95 |
-
assets/third_party/<asset_type>/<category>/<asset_id>/
|
| 96 |
```
|
| 97 |
|
| 98 |
Do not rely only on remote third-party URLs for reproducibility. Record the original URL, license, retrieval date, and any conversion steps in `metadata.yaml`.
|
|
@@ -136,7 +144,8 @@ The manifest is the global index. Keep one JSON object per line.
|
|
| 136 |
Before upload, run:
|
| 137 |
|
| 138 |
```bash
|
| 139 |
-
python scripts/validate_asset.py assets/<source>/<asset_type>/<category>/<asset_id>
|
|
|
|
| 140 |
python scripts/validate_asset.py --all
|
| 141 |
```
|
| 142 |
|
|
|
|
| 19 |
Use this canonical layout:
|
| 20 |
|
| 21 |
```text
|
| 22 |
+
assets/<source>/raw/<asset_type>/<category>/<asset_id>/
|
| 23 |
```
|
| 24 |
|
| 25 |
Example:
|
| 26 |
|
| 27 |
```text
|
| 28 |
+
assets/robocasa/raw/fixtures/dishwashers/Dishwasher031/
|
| 29 |
```
|
| 30 |
|
| 31 |
Each asset directory must contain the source asset files and a `metadata.yaml`.
|
| 32 |
|
| 33 |
+
For large upstream asset trees with many internal relative references, still use the canonical four-level layout under `raw/` and index the tree as one collection-level asset. Current example:
|
| 34 |
|
| 35 |
```text
|
| 36 |
+
assets/discoverse/raw/collections/models/discoverse_models/
|
| 37 |
```
|
| 38 |
|
| 39 |
This avoids breaking MJCF includes and mesh paths.
|
| 40 |
|
| 41 |
+
Derived outputs must live under:
|
| 42 |
+
|
| 43 |
+
```text
|
| 44 |
+
assets/<source>/derived/<asset_type>/<category>/<asset_id>/
|
| 45 |
+
```
|
| 46 |
+
|
| 47 |
+
Use `derived/` for convex decomposition, collision meshes, cleaned meshes, conversions, and other generated outputs. Do not overwrite raw assets.
|
| 48 |
+
|
| 49 |
Whenever a source is reorganized during import, record the original upstream layout and the current layout in:
|
| 50 |
|
| 51 |
```text
|
|
|
|
| 100 |
If any external third-party asset is used by a project, experiment, dataset, or generated scene, copy that exact used asset into this repository under:
|
| 101 |
|
| 102 |
```text
|
| 103 |
+
assets/third_party/raw/<asset_type>/<category>/<asset_id>/
|
| 104 |
```
|
| 105 |
|
| 106 |
Do not rely only on remote third-party URLs for reproducibility. Record the original URL, license, retrieval date, and any conversion steps in `metadata.yaml`.
|
|
|
|
| 144 |
Before upload, run:
|
| 145 |
|
| 146 |
```bash
|
| 147 |
+
python scripts/validate_asset.py assets/<source>/raw/<asset_type>/<category>/<asset_id>
|
| 148 |
+
python scripts/validate_asset.py assets/<source>/derived/<asset_type>/<category>/<asset_id>
|
| 149 |
python scripts/validate_asset.py --all
|
| 150 |
```
|
| 151 |
|