Xinyang Li commited on
Commit
e7b2f35
·
unverified ·
1 Parent(s): 2517b6c

Revise README for arXiv link and installation steps

Browse files

Updated README with new arXiv link and installation instructions.

Files changed (1) hide show
  1. README.md +44 -8
README.md CHANGED
@@ -5,7 +5,7 @@
5
  <em>FlashWorld: High-quality 3D Scene Generation within Seconds</em></h2>
6
 
7
  <p align="center">
8
- <!-- <a href="https://arxiv.org/pdf/2406.17601"><img src='https://img.shields.io/badge/arXiv-Director3D-red?logo=arxiv' alt='Paper PDF'></a> -->
9
  <a href='https://imlixinyang.github.io/FlashWorld-Project-Page'><img src='https://img.shields.io/badge/Project_Page-FlashWorld-green' alt='Project Page'></a>
10
  <!-- <a href='https://colab.research.google.com/drive/1LtnxgBU7k4gyymOWuonpOxjatdJ7AI8z?usp=sharing'><img src='https://img.shields.io/badge/Colab_Demo-Director3D-yellow?logo=googlecolab' alt='Project Page'></a> -->
11
  </p>
@@ -16,26 +16,62 @@
16
  </p>
17
 
18
 
19
- ***TL;DR:*** FlashWorld enables fast (**7 seconds on a single GPU**) and high-quality 3D scene generation across diverse scenes, from a single image or text prompt.
20
 
 
21
 
22
- **🔥 News**:
23
 
 
24
 
 
25
 
26
  The code will be released soon. Please stay tuned!
27
 
28
- - [10.14] Paper released.
29
 
30
- ## Generation Results
31
 
32
- [https://github.com/user-attachments/assets/bbdbe5de-5e15-4471-b380-4d8191688d82](https://github.com/user-attachments/assets/53d41748-4c35-48c4-9771-f458421c0b38)
 
 
 
 
33
 
 
 
 
 
 
34
 
35
- ## Demo
 
 
 
 
36
 
37
- https://github.com/user-attachments/assets/12ba4776-e7b7-4152-b885-dd6161aa9b4b
 
 
 
38
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
39
 
40
 
41
  ## License
 
5
  <em>FlashWorld: High-quality 3D Scene Generation within Seconds</em></h2>
6
 
7
  <p align="center">
8
+ <a href="https://arxiv.org/pdf/xxx"><img src='https://img.shields.io/badge/arXiv-FlashWorld-red?logo=arxiv' alt='Paper PDF'></a>
9
  <a href='https://imlixinyang.github.io/FlashWorld-Project-Page'><img src='https://img.shields.io/badge/Project_Page-FlashWorld-green' alt='Project Page'></a>
10
  <!-- <a href='https://colab.research.google.com/drive/1LtnxgBU7k4gyymOWuonpOxjatdJ7AI8z?usp=sharing'><img src='https://img.shields.io/badge/Colab_Demo-Director3D-yellow?logo=googlecolab' alt='Project Page'></a> -->
11
  </p>
 
16
  </p>
17
 
18
 
19
+ ***TL;DR:*** FlashWorld enables fast (**7 seconds on a single A100/A800 GPU**) and high-quality 3D scene generation across diverse scenes, from a single image or text prompt.
20
 
21
+ FlashWorld also supports slightly slower generation with only **24GB** GPU memory.
22
 
23
+ ## Demo
24
 
25
+ https://github.com/user-attachments/assets/12ba4776-e7b7-4152-b885-dd6161aa9b4b
26
 
27
+ ## 🔥 News:
28
 
29
  The code will be released soon. Please stay tuned!
30
 
31
+ - [2025.10.15] Paper released.
32
 
33
+ ## Installation
34
 
35
+ - install packages
36
+ ```
37
+ pip install torch torchvision
38
+ pip install triton transformers pytorch_lightning omegaconf ninja numpy jaxtyping rich tensorboard einops moviepy==1.0.3 webdataset accelerate opencv-python lpips av plyfile ftfy peft tensorboard pandas flask
39
+ ```
40
 
41
+ - install ```[email protected]``` and ```diffusers@wan-5Bi2v``` packages
42
+ ```
43
+ pip install git+https://github.com/nerfstudio-project/gsplat.git@32f2a54d21c7ecb135320bb02b136b7407ae5712
44
+ pip install git+https://github.com/huggingface/diffusers.git@447e8322f76efea55d4769cd67c372edbf0715b8
45
+ ```
46
 
47
+ - clone this repo:
48
+ ```
49
+ git clone https://github.com/imlixinyang/FlashWorld.git
50
+ cd FlashWorld
51
+ ```
52
 
53
+ - download the pre-trained model by:
54
+ ```
55
+ wget https://huggingface.co/imlixinyang/flashworld_ckpt/resolve/main/model.ckpt?download=true -O model.ckpt
56
+ ```
57
 
58
+ - run our demo backend by:
59
+ ```
60
+ python backend.py
61
+ ```
62
+
63
+ - open frontend webpage at ```index.html```, possibly by:
64
+ ```
65
+ pip install tiny-http-server
66
+ tiny-http-server --directory / --port 8081 --bind 0.0.0.0 --auth username:password
67
+ ```
68
+
69
+ Then, enjoy your journey in FlashWorld!
70
+
71
+
72
+ ## More Generation Results
73
+
74
+ [https://github.com/user-attachments/assets/bbdbe5de-5e15-4471-b380-4d8191688d82](https://github.com/user-attachments/assets/53d41748-4c35-48c4-9771-f458421c0b38)
75
 
76
 
77
  ## License