WasabiOctopus commited on
Commit
eea05f1
·
verified ·
1 Parent(s): d7af4f8

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +39 -41
README.md CHANGED
@@ -1,3 +1,12 @@
 
 
 
 
 
 
 
 
 
1
  <div align="center">
2
 
3
  # 🐙 WasabiOctopus / LGM
@@ -12,7 +21,7 @@
12
  <img src="https://img.shields.io/badge/License-MIT-green">
13
  </p>
14
 
15
- **A Diffusers-ready LGM pipeline for fast 3D content creation from text or a single image.**
16
 
17
  </div>
18
 
@@ -20,17 +29,17 @@
20
 
21
  ## ✨ Highlights
22
 
23
- * 🚀 **Fast 3D asset generation** powered by the LGM pipeline.
24
- * 🧊 **3D Gaussian Splatting representation** for efficient high-resolution 3D content.
25
- * 🖼️ **Text-to-3D and image-to-3D workflows** through multi-view diffusion.
26
- * 🧩 **Diffusers-compatible model structure** with `LGMFullPipeline`.
27
- * 🔬 Useful for **3D generation research, creative prototyping, course projects, and rapid experimentation**.
28
 
29
  ---
30
 
31
  ## 🖼️ Gallery
32
 
33
- > Upload your own generated examples to an `assets/` folder and replace the placeholders below.
34
 
35
  | Prompt / Input | Generated 3D Asset |
36
  | ----------------------------------------------------- | ------------------ |
@@ -42,9 +51,9 @@
42
 
43
  ## 🧠 What is LGM?
44
 
45
- **LGM**, short for **Large Multi-View Gaussian Model**, is a 3D generation framework designed for high-resolution 3D content creation.
46
 
47
- Instead of directly generating a mesh from scratch, the pipeline first produces multi-view visual information and then reconstructs a 3D Gaussian representation. This makes it suitable for fast, feed-forward 3D asset generation from either a text prompt or a single input image.
48
 
49
  This repository provides a convenient Hugging Face / Diffusers-style release of the full LGM pipeline.
50
 
@@ -52,19 +61,12 @@ This repository provides a convenient Hugging Face / Diffusers-style release of
52
 
53
  ## 🏗️ Pipeline Overview
54
 
55
- ```text
56
  Text prompt or single image
57
-
58
- Multi-view diffusion generation
59
-
60
- Multi-view Gaussian features
61
-
62
- LGM reconstruction module
63
-
64
- 3D Gaussian asset
65
-
66
- PLY export / downstream rendering
67
- ```
68
 
69
  ---
70
 
@@ -72,17 +74,15 @@ PLY export / downstream rendering
72
 
73
  ### 1. Install dependencies
74
 
75
- ```bash
76
  pip install -U diffusers transformers accelerate safetensors
77
  pip install torch torchvision torchaudio
78
  pip install xformers trimesh kiui plyfile
79
  ```
80
 
81
- For the full environment, check the repository `requirements.txt`.
82
-
83
  ### 2. Load the pipeline
84
 
85
- ```python
86
  import torch
87
  from diffusers import DiffusionPipeline
88
 
@@ -99,7 +99,7 @@ pipe = pipe.to("cuda")
99
 
100
  ### 3. Text-to-3D generation
101
 
102
- ```python
103
  prompt = "a cute robot, smooth toy material, studio lighting, clean geometry"
104
 
105
  gaussians = pipe(
@@ -113,7 +113,7 @@ pipe.save_ply(gaussians, "robot.ply")
113
 
114
  ### 4. Image-to-3D generation
115
 
116
- ```python
117
  import numpy as np
118
  from PIL import Image
119
 
@@ -134,7 +134,7 @@ pipe.save_ply(gaussians, "asset_from_image.ply")
134
 
135
  ## 📦 Repository Contents
136
 
137
- ```text
138
  WasabiOctopus/LGM
139
  ├── README.md
140
  ├── model_index.json
@@ -156,8 +156,8 @@ WasabiOctopus/LGM
156
 
157
  This model release is useful for:
158
 
159
- * Fast **single-image-to-3D** prototyping
160
- * **Text-to-3D** creative asset generation
161
  * 3D generation course projects
162
  * Research demos around 3D Gaussian Splatting
163
  * Benchmarking recent 3D asset generation pipelines
@@ -183,18 +183,14 @@ For professional 3D asset production, additional post-processing may be needed,
183
 
184
  Good prompts usually describe:
185
 
186
- ```text
187
- object category + style + material + lighting + geometry constraint
188
- ```
189
 
190
  Examples:
191
 
192
- ```text
193
- a cute robot, rounded toy design, smooth plastic material, studio lighting
194
- a medieval treasure chest, golden metal details, wooden texture, clean geometry
195
- a sci-fi helmet, hard-surface design, matte black material, sharp edges
196
- a tiny house, stylized low-poly, warm colors, isometric game asset
197
- ```
198
 
199
  For image-to-3D, use images with:
200
 
@@ -217,7 +213,9 @@ For image-to-3D, use images with:
217
 
218
  ## 🙏 Acknowledgements
219
 
220
- This repository is based on the LGM ecosystem and the upstream Hugging Face full pipeline release. Full credit for the original LGM method goes to the authors of:
 
 
221
 
222
  **LGM: Large Multi-View Gaussian Model for High-Resolution 3D Content Creation**
223
 
@@ -229,7 +227,7 @@ This release is intended as a convenient Hugging Face / Diffusers-compatible res
229
 
230
  If you use this model or the original LGM method, please cite:
231
 
232
- ```bibtex
233
  @article{tang2024lgm,
234
  title={LGM: Large Multi-View Gaussian Model for High-Resolution 3D Content Creation},
235
  author={Tang, Jiaxiang and Chen, Zhaoxi and Chen, Xiaokang and Wang, Tengfei and Zeng, Gang and Liu, Ziwei},
 
1
+ ---
2
+
3
+ license: mit
4
+ pipeline_tag: image-to-3d
5
+ library_name: diffusers
6
+ tags: ["image-to-3d", "text-to-3d", "3d-generation", "3d-gaussian-splatting", "gaussian-splatting", "multi-view-diffusion", "diffusers", "safetensors", "research"]
7
+
8
+ ---
9
+
10
  <div align="center">
11
 
12
  # 🐙 WasabiOctopus / LGM
 
21
  <img src="https://img.shields.io/badge/License-MIT-green">
22
  </p>
23
 
24
+ **A clean Diffusers-ready LGM release for fast 3D content creation from text or a single image.**
25
 
26
  </div>
27
 
 
29
 
30
  ## ✨ Highlights
31
 
32
+ * 🚀 Fast 3D asset generation powered by the LGM pipeline.
33
+ * 🧊 3D Gaussian Splatting representation for efficient 3D content creation.
34
+ * 🖼️ Supports text-to-3D and image-to-3D workflows.
35
+ * 🧩 Diffusers-compatible model structure.
36
+ * 🔬 Useful for 3D generation research, creative prototyping, and rapid experimentation.
37
 
38
  ---
39
 
40
  ## 🖼️ Gallery
41
 
42
+ Generated examples will be added soon.
43
 
44
  | Prompt / Input | Generated 3D Asset |
45
  | ----------------------------------------------------- | ------------------ |
 
51
 
52
  ## 🧠 What is LGM?
53
 
54
+ **LGM**, short for **Large Multi-View Gaussian Model**, is a 3D generation framework for high-resolution 3D content creation.
55
 
56
+ Instead of directly generating a mesh from scratch, the pipeline first produces multi-view visual information and then reconstructs a 3D Gaussian representation. This makes it suitable for fast feed-forward 3D asset generation from either a text prompt or a single input image.
57
 
58
  This repository provides a convenient Hugging Face / Diffusers-style release of the full LGM pipeline.
59
 
 
61
 
62
  ## 🏗️ Pipeline Overview
63
 
 
64
  Text prompt or single image
65
+ → Multi-view diffusion generation
66
+ Multi-view Gaussian features
67
+ → LGM reconstruction module
68
+ 3D Gaussian asset
69
+ → PLY export / downstream rendering
 
 
 
 
 
 
70
 
71
  ---
72
 
 
74
 
75
  ### 1. Install dependencies
76
 
77
+ ```
78
  pip install -U diffusers transformers accelerate safetensors
79
  pip install torch torchvision torchaudio
80
  pip install xformers trimesh kiui plyfile
81
  ```
82
 
 
 
83
  ### 2. Load the pipeline
84
 
85
+ ```
86
  import torch
87
  from diffusers import DiffusionPipeline
88
 
 
99
 
100
  ### 3. Text-to-3D generation
101
 
102
+ ```
103
  prompt = "a cute robot, smooth toy material, studio lighting, clean geometry"
104
 
105
  gaussians = pipe(
 
113
 
114
  ### 4. Image-to-3D generation
115
 
116
+ ```
117
  import numpy as np
118
  from PIL import Image
119
 
 
134
 
135
  ## 📦 Repository Contents
136
 
137
+ ```
138
  WasabiOctopus/LGM
139
  ├── README.md
140
  ├── model_index.json
 
156
 
157
  This model release is useful for:
158
 
159
+ * Fast single-image-to-3D prototyping
160
+ * Text-to-3D creative asset generation
161
  * 3D generation course projects
162
  * Research demos around 3D Gaussian Splatting
163
  * Benchmarking recent 3D asset generation pipelines
 
183
 
184
  Good prompts usually describe:
185
 
186
+ **object category + style + material + lighting + geometry constraint**
 
 
187
 
188
  Examples:
189
 
190
+ * `a cute robot, rounded toy design, smooth plastic material, studio lighting`
191
+ * `a medieval treasure chest, golden metal details, wooden texture, clean geometry`
192
+ * `a sci-fi helmet, hard-surface design, matte black material, sharp edges`
193
+ * `a tiny house, stylized low-poly, warm colors, isometric game asset`
 
 
194
 
195
  For image-to-3D, use images with:
196
 
 
213
 
214
  ## 🙏 Acknowledgements
215
 
216
+ This repository is based on the LGM ecosystem and the upstream Hugging Face full pipeline release.
217
+
218
+ Full credit for the original LGM method goes to the authors of:
219
 
220
  **LGM: Large Multi-View Gaussian Model for High-Resolution 3D Content Creation**
221
 
 
227
 
228
  If you use this model or the original LGM method, please cite:
229
 
230
+ ```
231
  @article{tang2024lgm,
232
  title={LGM: Large Multi-View Gaussian Model for High-Resolution 3D Content Creation},
233
  author={Tang, Jiaxiang and Chen, Zhaoxi and Chen, Xiaokang and Wang, Tengfei and Zeng, Gang and Liu, Ziwei},