cpuai commited on
Commit
abfe15b
·
verified ·
1 Parent(s): da8e91e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -101
README.md CHANGED
@@ -1,101 +1,13 @@
1
- ---
2
- title: TRELLIS.2 Multi-Image Conditioning
3
- emoji: 🧊
4
- colorFrom: blue
5
- colorTo: purple
6
- sdk: gradio
7
- sdk_version: 5.12.0
8
- app_file: app.py
9
- pinned: false
10
- license: mit
11
- short_description: Multi-view image to 3D generation
12
- ---
13
-
14
- # TRELLIS.2 Multi-Image Conditioning Fork
15
-
16
- This fork extends [TRELLIS.2](https://github.com/microsoft/TRELLIS.2) with multi-image conditioning and Windows support.
17
-
18
- ## What's New
19
-
20
- - **Multi-image conditioning**: Use multiple views for better 3D reconstruction
21
- - **Windows support**: Runs on Windows with automatic `sdpa` attention fallback
22
-
23
- > For the interactive visualization tool, see the [viser_view branch](https://github.com/OpsiClear/Trellis2_multi_image_conditioning/tree/viser_view).
24
-
25
- ## Installation
26
-
27
- ```sh
28
- git clone https://github.com/OpsiClear/Trellis2_multi_image_conditioning.git --recursive
29
- cd Trellis2_multi_image_conditioning
30
- . ./setup.sh --new-env --basic --flash-attn --nvdiffrast --nvdiffrec --cumesh --o-voxel --flexgemm
31
- ```
32
-
33
- > On Windows, `flash-attn` is unavailable. The code automatically falls back to PyTorch's native `sdpa` backend.
34
-
35
- ## Usage
36
-
37
- ### Multi-Image Generation
38
-
39
- ```python
40
- from trellis2.pipelines import Trellis2ImageTo3DPipeline
41
- from PIL import Image
42
-
43
- pipeline = Trellis2ImageTo3DPipeline.from_pretrained("microsoft/TRELLIS.2-4B")
44
- pipeline.cuda()
45
-
46
- # Load multiple views
47
- images = [Image.open(f"view_{i}.png") for i in range(4)]
48
-
49
- # Generate with multi-image conditioning
50
- mesh = pipeline.run_multi_image(images)[0]
51
- ```
52
-
53
- Or run the example:
54
- ```sh
55
- python example_multi_image.py
56
- ```
57
-
58
- ### Other Examples
59
-
60
- ```sh
61
- python example.py # Single image generation
62
- python app.py # Gradio web demo
63
- python example_texturing.py # PBR texture generation
64
- python app_texturing.py # Texture generation web demo
65
- ```
66
-
67
- ## Attribution
68
-
69
- This project is a fork of [TRELLIS.2](https://github.com/microsoft/TRELLIS.2) by Microsoft Corporation, originally released under the MIT License.
70
-
71
- For full documentation, training instructions, and model details, see the original repository.
72
-
73
- If you use this code, please cite the original paper:
74
-
75
- ```bibtex
76
- @article{xiang2025trellis2,
77
- title={Native and Compact Structured Latents for 3D Generation},
78
- author={Xiang, Jianfeng and Chen, Xiaoxue and Xu, Sicheng and Wang, Ruicheng and Lv, Zelong and Deng, Yu and Zhu, Hongyuan and Dong, Yue and Zhao, Hao and Yuan, Nicholas Jing and Yang, Jiaolong},
79
- journal={Tech report},
80
- year={2025}
81
- }
82
- ```
83
-
84
- ## Third-Party Model Licenses
85
-
86
- This project uses several third-party models with different licenses. **Some licenses prohibit commercial use.** See [MODEL_LICENSES.md](MODEL_LICENSES.md) for full details.
87
-
88
- | Model | License | Commercial Use |
89
- |---|---|---|
90
- | [TRELLIS.2-4B](https://huggingface.co/microsoft/TRELLIS.2-4B) | MIT | Yes* |
91
- | [BRIA RMBG-2.0](https://huggingface.co/briaai/RMBG-2.0) | CC BY-NC 4.0 | **No** |
92
- | [DINOv2](https://github.com/facebookresearch/dinov2) | Apache 2.0 | Yes |
93
- | [BiRefNet](https://github.com/ZhengPeng7/BiRefNet) | MIT | Yes |
94
-
95
- *\* Depends on nvdiffrast/nvdiffrec (NVIDIA Source Code License, non-commercial only)*
96
-
97
- Original license files are included in the [`licenses/`](licenses/) directory.
98
-
99
- ## License
100
-
101
- The original TRELLIS.2 code is MIT licensed by Microsoft Corporation. New additions in this fork (multi-image conditioning) are licensed under [AGPL-3.0](LICENSE).
 
1
+ ---
2
+ title: TRELLIS.2 Multi-Image Conditioning
3
+ emoji: 🧊
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: gradio
7
+ sdk_version: 6.1.0
8
+ python_version: 3.12
9
+ app_file: app.py
10
+ pinned: false
11
+ license: mit
12
+ short_description: Multi-view image to 3D generation
13
+ ---