Datasets:

Languages:
English
ArXiv:
License:
mattdeitke commited on
Commit
26dfb56
1 Parent(s): bbe71f1

Update README.md

Browse files
Files changed (1) hide show
  1. scripts/rendering/README.md +44 -2
scripts/rendering/README.md CHANGED
@@ -39,13 +39,15 @@ cd ../.. && \
39
 
40
  ## 📸 Example Usage
41
 
 
 
42
  After setup, we can start to render objects using the `main.py` script:
43
 
44
  ```bash
45
  python3 main.py
46
  ```
47
 
48
- After running this, you should see 10 zip files located in `~/.objaverse/github/renders`, which correspond to renders of objects from [our example 3D objects repo](https://github.com/mattdeitke/objaverse-xl-test-files):
49
 
50
  ```bash
51
  > ls ~/.objaverse/github/renders
@@ -74,7 +76,7 @@ Here, we see that there are 12 renders `[000-011].png`. Each render will look so
74
 
75
  ![temp](https://github.com/allenai/objaverse-xl/assets/28768645/69d79e26-4df1-4bd2-854c-7d3c888adae7)
76
 
77
- Additionally, there are 12 npy files `[000-011].npy`, which information about the cameras pose for a given render. We can read the npy files using:
78
 
79
  ```python
80
  import numpy as np
@@ -89,5 +91,45 @@ array([[6.07966840e-01, 7.93962419e-01, 3.18103019e-08, 2.10451518e-07],
89
  [6.35699809e-01, -4.86779213e-01, -5.99109232e-01, -1.66008198e+00]])
90
  ```
91
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
92
  **Note.** USDZ support is experimental. Since Blender does not natively support usdz, we use [this Blender addon](https://github.com/robmcrosby/BlenderUSDZ), but it doesn't work with all types of USDZs. If you have a better solution, PRs are very much welcome 😄!
93
 
 
39
 
40
  ## 📸 Example Usage
41
 
42
+ ### 🐥 Minimal Example
43
+
44
  After setup, we can start to render objects using the `main.py` script:
45
 
46
  ```bash
47
  python3 main.py
48
  ```
49
 
50
+ After running this, you should see 10 zip files located in `~/.objaverse/github/renders`. Each zip file corresponds to the rendering of a unique object, in this case from [our example 3D objects repo](https://github.com/mattdeitke/objaverse-xl-test-files):
51
 
52
  ```bash
53
  > ls ~/.objaverse/github/renders
 
76
 
77
  ![temp](https://github.com/allenai/objaverse-xl/assets/28768645/69d79e26-4df1-4bd2-854c-7d3c888adae7)
78
 
79
+ Additionally, there are 12 npy files `[000-011].npy`, which include information about the camera's pose for a given render. We can read the npy files using:
80
 
81
  ```python
82
  import numpy as np
 
91
  [6.35699809e-01, -4.86779213e-01, -5.99109232e-01, -1.66008198e+00]])
92
  ```
93
 
94
+ Finally, we also have a `metadata.json` file, which contains metadata about the object and scene:
95
+
96
+ ```json
97
+ {
98
+ "animation_count": 0,
99
+ "armature_count": 0,
100
+ "edge_count": 2492,
101
+ "file_identifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.abc",
102
+ "file_size": 108916,
103
+ "lamp_count": 1,
104
+ "linked_files": [],
105
+ "material_count": 0,
106
+ "mesh_count": 3,
107
+ "missing_textures": {
108
+ "count": 0,
109
+ "file_path_to_color": {},
110
+ "files": []
111
+ },
112
+ "object_count": 8,
113
+ "poly_count": 984,
114
+ "random_color": null,
115
+ "save_uid": "0fde27a0-99f0-5029-8e20-be9b8ecabb59",
116
+ "scene_size": {
117
+ "bbox_max": [
118
+ 4.999998569488525,
119
+ 6.0,
120
+ 1.0
121
+ ],
122
+ "bbox_min": [
123
+ -4.999995231628418,
124
+ -6.0,
125
+ -1.0
126
+ ]
127
+ },
128
+ "sha256": "879bc9d2d85e4f3866f0cfef41f5236f9fff5f973380461af9f69cdbed53a0da",
129
+ "shape_key_count": 0,
130
+ "vert_count": 2032
131
+ }
132
+ ```
133
+
134
  **Note.** USDZ support is experimental. Since Blender does not natively support usdz, we use [this Blender addon](https://github.com/robmcrosby/BlenderUSDZ), but it doesn't work with all types of USDZs. If you have a better solution, PRs are very much welcome 😄!
135