yuchi233 commited on
Commit
cb204ca
·
verified ·
1 Parent(s): d76b924

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +58 -1
README.md CHANGED
@@ -6,6 +6,8 @@ This repository stores normalized reusable assets from RoboCasa, Discoverse, Tin
6
 
7
  ## Layout
8
 
 
 
9
  ```text
10
  assets/<source>/<asset_type>/<category>/<asset_id>/
11
  ```
@@ -16,6 +18,54 @@ Example:
16
  assets/robocasa/fixtures/dishwashers/Dishwasher031/
17
  ```
18
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
  ## Current seed assets
20
 
21
  - RoboCasa dishwasher fixtures: 25 MJCF assets under `assets/robocasa/fixtures/dishwashers/`
@@ -26,6 +76,13 @@ assets/robocasa/fixtures/dishwashers/Dishwasher031/
26
  - stored as a collection-level asset to preserve internal relative references
27
  - includes MJCF, URDF, mesh, and reference image files
28
 
 
 
 
 
 
 
 
29
  ## Index
30
 
31
  The global asset index is:
@@ -55,7 +112,7 @@ Login first:
55
 
56
  ```bash
57
  export HF_ENDPOINT=https://hf-mirror.com
58
- hf login
59
  ```
60
 
61
  Create the dataset repo if needed:
 
6
 
7
  ## Layout
8
 
9
+ Default normalized asset layout:
10
+
11
  ```text
12
  assets/<source>/<asset_type>/<category>/<asset_id>/
13
  ```
 
18
  assets/robocasa/fixtures/dishwashers/Dishwasher031/
19
  ```
20
 
21
+ Collection-level imports are allowed when an upstream repository has many internal relative references:
22
+
23
+ ```text
24
+ assets/<source>/<upstream_root>/
25
+ ```
26
+
27
+ Current example:
28
+
29
+ ```text
30
+ assets/discoverse/models/
31
+ ```
32
+
33
+ Top-level repository structure:
34
+
35
+ ```text
36
+ .
37
+ ├── AGENTS.md
38
+ ├── README.md
39
+ ├── assets/
40
+ │ ├── discoverse/
41
+ │ ├── hunter/
42
+ │ ├── robocasa/
43
+ │ ├── third_party/
44
+ │ └── tinyforge/
45
+ ├── docs/
46
+ │ ├── naming_spec.md
47
+ │ ├── placement_asset_notes.md
48
+ │ ├── source_notes/
49
+ │ └── storage_spec.md
50
+ ├── manifest/
51
+ │ ├── assets.jsonl
52
+ │ ├── licenses.yaml
53
+ │ └── sources.yaml
54
+ └── scripts/
55
+ ```
56
+
57
+ Naming rule:
58
+
59
+ ```text
60
+ <source>.<asset_type>.<category>.<upstream_id>
61
+ ```
62
+
63
+ Example:
64
+
65
+ ```text
66
+ robocasa.fixtures.dishwashers.Dishwasher031
67
+ ```
68
+
69
  ## Current seed assets
70
 
71
  - RoboCasa dishwasher fixtures: 25 MJCF assets under `assets/robocasa/fixtures/dishwashers/`
 
76
  - stored as a collection-level asset to preserve internal relative references
77
  - includes MJCF, URDF, mesh, and reference image files
78
 
79
+ Placement-related notes and candidate external links are tracked in:
80
+
81
+ ```text
82
+ docs/placement_asset_notes.md
83
+ docs/source_notes/third_party.md
84
+ ```
85
+
86
  ## Index
87
 
88
  The global asset index is:
 
112
 
113
  ```bash
114
  export HF_ENDPOINT=https://hf-mirror.com
115
+ hf auth login
116
  ```
117
 
118
  Create the dataset repo if needed: