lprantl commited on
Commit
c4ec8d4
·
verified ·
1 Parent(s): b404944

Update dataset card for the descriptive asset names (v04)

Browse files
Files changed (1) hide show
  1. README.md +15 -16
README.md CHANGED
@@ -28,7 +28,7 @@ in Isaac Sim. The validation and benchmark results travel with the package.
28
 
29
  | | |
30
  |---|---|
31
- | Objects | 100 real-world objects, one package each |
32
  | Profile | `Robotics-Prop` 4.0.0 (SimReady Foundation) |
33
  | Up axis / units | Z-up, meters (`metersPerUnit = 1`), kilograms |
34
  | Visual LODs | `0` = full-resolution scan mesh (**default**, 0.8–2.6 M triangles), `1` = reduced mesh (about 600k triangles) |
@@ -40,24 +40,23 @@ in Isaac Sim. The validation and benchmark results travel with the package.
40
 
41
  ## Package layout
42
 
43
- Each top-level folder is one package. The folder name is the object's item ID. IDs that
44
- start with a digit have a leading underscore (`_0SDU0DKMY8/`), because USD names cannot
45
- start with a digit.
46
 
47
  ```
48
- <ID>/
49
  ├─ com.nvidia.simready.packaging.json package definition (package ID, version, license)
50
  ├─ .metadata/
51
  │ ├─ com.nvidia.simready.packaging.bom.json bill of materials: every file with its SHA-256 hash
52
  │ ├─ com.nvidia.simready.conformance.*.json packaging profile result
53
- │ ├─ <ID>_validation.json profile validation results
54
- │ └─ <ID>_benchmark.json Isaac Sim benchmark results
55
  └─ simready_usd/
56
- ├─ <ID>.usd entry file: open or reference this one
57
  ├─ .thumbs/256x256/
58
- │ ├─ <ID>.usd.png thumbnail, dark background
59
- │ ├─ <ID>.usd_light.png thumbnail, light background
60
- │ └─ <ID>.usd_transparent.png thumbnail, transparent background
61
  ├─ payloads/ geometry, LOD and physics layers
62
  ├─ runnables/physics/physx.usda PhysX-specific settings, loaded by the PhysX variant
63
  └─ textures/
@@ -79,11 +78,11 @@ category, Wikidata Q-code, extents, mass and rigid-body count.
79
  ## Versions
80
 
81
  Each package is uploaded at a fixed commit of this dataset. The package ID includes the
82
- version: `simready.hf.ALLSIDES.simready-scanned-objects.<ID>.<version>`. The SimReady Catalog refers
83
  to each version by its commit-pinned URL:
84
 
85
  ```
86
- https://huggingface.co/datasets/ALLSIDES/simready-scanned-objects/resolve/<commit>/<ID>/com.nvidia.simready.packaging.json
87
  ```
88
 
89
  The `main` branch always holds the newest version of each package. Earlier versions stay
@@ -97,12 +96,12 @@ from huggingface_hub import snapshot_download
97
  path = snapshot_download(repo_id="ALLSIDES/simready-scanned-objects", repo_type="dataset")
98
  ```
99
 
100
- To download one asset only, pass `allow_patterns`, for example `allow_patterns="A07RDPW843/*"`.
101
  To download a fixed version, pass the commit as `revision`.
102
 
103
  ## Using the assets in Isaac Sim
104
 
105
- Drag `<ID>/simready_usd/<ID>.usd` into the viewport or the Stage window, or add it as a
106
  reference from Python. The asset appears under a prim of your choice (for example
107
  `/World/Object`), and its variant sets are available on that prim.
108
 
@@ -122,7 +121,7 @@ import omni.usd
122
 
123
  stage = omni.usd.get_context().get_stage()
124
  prim = stage.DefinePrim("/World/Object", "Xform")
125
- prim.GetReferences().AddReference("/path/to/<ID>/simready_usd/<ID>.usd")
126
 
127
  prim.GetVariantSet("lod").SetVariantSelection("1") # reduced mesh
128
  prim.GetVariantSet("PhysX").SetVariantSelection("Enabled") # load the PhysX settings
 
28
 
29
  | | |
30
  |---|---|
31
+ | Objects | 69 real-world objects, one package each |
32
  | Profile | `Robotics-Prop` 4.0.0 (SimReady Foundation) |
33
  | Up axis / units | Z-up, meters (`metersPerUnit = 1`), kilograms |
34
  | Visual LODs | `0` = full-resolution scan mesh (**default**, 0.8–2.6 M triangles), `1` = reduced mesh (about 600k triangles) |
 
40
 
41
  ## Package layout
42
 
43
+ Each top-level folder is one package. The folder name is the object's category followed
44
+ by its Allsides item ID, for example `mug_A07RDPW843/` or `drone_0SDU0DKMY8/`.
 
45
 
46
  ```
47
+ <name>/
48
  ├─ com.nvidia.simready.packaging.json package definition (package ID, version, license)
49
  ├─ .metadata/
50
  │ ├─ com.nvidia.simready.packaging.bom.json bill of materials: every file with its SHA-256 hash
51
  │ ├─ com.nvidia.simready.conformance.*.json packaging profile result
52
+ │ ├─ <name>_validation.json profile validation results
53
+ │ └─ <name>_benchmark.json Isaac Sim benchmark results
54
  └─ simready_usd/
55
+ ├─ <name>.usd entry file: open or reference this one
56
  ├─ .thumbs/256x256/
57
+ │ ├─ <name>.usd.png thumbnail, dark background
58
+ │ ├─ <name>.usd_light.png thumbnail, light background
59
+ │ └─ <name>.usd_transparent.png thumbnail, transparent background
60
  ├─ payloads/ geometry, LOD and physics layers
61
  ├─ runnables/physics/physx.usda PhysX-specific settings, loaded by the PhysX variant
62
  └─ textures/
 
78
  ## Versions
79
 
80
  Each package is uploaded at a fixed commit of this dataset. The package ID includes the
81
+ version: `simready.hf.ALLSIDES.simready-scanned-objects.<name>.<version>`. The SimReady Catalog refers
82
  to each version by its commit-pinned URL:
83
 
84
  ```
85
+ https://huggingface.co/datasets/ALLSIDES/simready-scanned-objects/resolve/<commit>/<name>/com.nvidia.simready.packaging.json
86
  ```
87
 
88
  The `main` branch always holds the newest version of each package. Earlier versions stay
 
96
  path = snapshot_download(repo_id="ALLSIDES/simready-scanned-objects", repo_type="dataset")
97
  ```
98
 
99
+ To download one asset only, pass `allow_patterns`, for example `allow_patterns="mug_A07RDPW843/*"`.
100
  To download a fixed version, pass the commit as `revision`.
101
 
102
  ## Using the assets in Isaac Sim
103
 
104
+ Drag `<name>/simready_usd/<name>.usd` into the viewport or the Stage window, or add it as a
105
  reference from Python. The asset appears under a prim of your choice (for example
106
  `/World/Object`), and its variant sets are available on that prim.
107
 
 
121
 
122
  stage = omni.usd.get_context().get_stage()
123
  prim = stage.DefinePrim("/World/Object", "Xform")
124
+ prim.GetReferences().AddReference("/path/to/<name>/simready_usd/<name>.usd")
125
 
126
  prim.GetVariantSet("lod").SetVariantSelection("1") # reduced mesh
127
  prim.GetVariantSet("PhysX").SetVariantSelection("Enabled") # load the PhysX settings