Update README.md
Browse files
README.md
CHANGED
@@ -1,5 +1,5 @@
|
|
1 |
---
|
2 |
-
license: cc-by-
|
3 |
task_categories:
|
4 |
- text-to-image
|
5 |
pretty_name: REVISION_GENERATOR
|
@@ -13,18 +13,39 @@ language:
|
|
13 |
|
14 |
This is the official dataset repo of the REVISION framework a.k.a. the 'Rendering Tool' with all involved assets (i.e. objects, backgrounds, and floors).
|
15 |
|
|
|
16 |
## Requirements
|
17 |
|
18 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
19 |
|
20 |
-
|
21 |
|
22 |
-
##
|
23 |
|
24 |
-
|
25 |
-
|
26 |
-
blenderproc vis hdf5 <path_to_ref_images>\<image_name>.hdf5
|
27 |
|
28 |
-
##
|
29 |
|
30 |
-
|
|
|
1 |
---
|
2 |
+
license: cc-by-4.0
|
3 |
task_categories:
|
4 |
- text-to-image
|
5 |
pretty_name: REVISION_GENERATOR
|
|
|
13 |
|
14 |
This is the official dataset repo of the REVISION framework a.k.a. the 'Rendering Tool' with all involved assets (i.e. objects, backgrounds, and floors).
|
15 |
|
16 |
+
|
17 |
## Requirements
|
18 |
|
19 |
+
REVISION requires [blenderproc](https://github.com/DLR-RM/BlenderProc). Simply install it with pip:
|
20 |
+
|
21 |
+
```
|
22 |
+
pip install blenderproc
|
23 |
+
```
|
24 |
+
|
25 |
+
## Single Test Run
|
26 |
+
|
27 |
+
To generate a two-object reference image deterministically on your own, you may invoke one of the 4 blenderproc scripts in `util/`. E.g., to generate a scene of 'an **apple** *to the left* of a **banana**' in an indoor background, you may use
|
28 |
+
|
29 |
+
```
|
30 |
+
blenderproc run util/blender_left_right_floor.py apple banana background/photo_studio_loft_hall_2k.hdr output/debug/ 0 0
|
31 |
+
```
|
32 |
+
|
33 |
+
## Batched Test Run
|
34 |
+
|
35 |
+
We also provide ``revision_gen_sample_t2i_comp.sh`` or `` revision_gen_sample_mscoco.sh`` to synthesize a sample batch of REVISION reference images in hdf5 format. You may then visualize the reference images with:
|
36 |
+
|
37 |
+
```
|
38 |
+
blenderproc vis hdf5 <path_to_ref_images>/<image_name>.hdf5
|
39 |
+
```
|
40 |
+
|
41 |
+
## Sample rendered outputs
|
42 |
|
43 |
+
For convenience, we also have provided rendered outputs in PNG format for all two-object-pairs in MSCOCO or those specified in T2I-CompBench. These images are also the ones used in the RevQA Benchmark. Please find out more under the folder [sample_output/](https://huggingface.co/datasets/revision-t2i/revision-generator/tree/main/sample_output) .
|
44 |
|
45 |
+
## Citation
|
46 |
|
47 |
+
TBA
|
|
|
|
|
48 |
|
49 |
+
## Acknowledgement
|
50 |
|
51 |
+
The floor textures and the object models are sourced and modified from [sketchfab.com](https://sketchfab.com). The textured background assets are sourced from [polyhaven.com](http://polyhaven.com). All assets are shared in accordance with [CC-BY-4.0 License](https://creativecommons.org/licenses/by/4.0/deed.en#:~:text=https%3A//creativecommons.org/licenses/by/4.0/).
|