Thelocallab commited on
Commit
a93e7c9
·
verified ·
1 Parent(s): 2a25020

Add model card: package inventory, install steps, per-package licence notice

Browse files

Documents the five packages, Python/platform matrix, install and troubleshooting steps, and states the differing licence terms (MIT for TRELLIS.2 components; NVIDIA non-commercial for nvdiffrast/nvdiffrec_render).

Files changed (1) hide show
  1. README.md +118 -0
README.md ADDED
@@ -0,0 +1,118 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ license_name: mixed-mit-and-nvidia-non-commercial
4
+ license_link: https://huggingface.co/Thelocallab/CUDA-wheels/blob/main/README.md
5
+ tags:
6
+ - comfyui
7
+ - trellis
8
+ - windows
9
+ - cuda
10
+ - wheels
11
+ - 3d-generation
12
+ - prebuilt
13
+ library_name: other
14
+ ---
15
+
16
+ # Prebuilt Windows CUDA Wheels for TRELLIS.2 / 3D Generation in ComfyUI
17
+
18
+ Precompiled Python wheels for the CUDA extensions that
19
+ [TRELLIS.2](https://github.com/microsoft/TRELLIS.2) needs — so you don't have to set up
20
+ MSVC, the CUDA toolkit, and Triton on Windows just to run image-to-3D.
21
+
22
+ If you've ever watched `setup.sh --cumesh --o-voxel --flexgemm --nvdiffrast --nvdiffrec`
23
+ fail on Windows, this is for you.
24
+
25
+ > ### ⚠️ Read this before downloading — licences differ per package
26
+ >
27
+ > These are **builds of other people's source code**, not original work, and they are **not
28
+ > all under the same terms**:
29
+ >
30
+ > - **`cumesh`, `flex_gemm`, `o_voxel`** — components of
31
+ > [microsoft/TRELLIS.2](https://github.com/microsoft/TRELLIS.2), **MIT licensed**.
32
+ > Unmodified compilations, redistributed under the same terms.
33
+ > - **`nvdiffrast`, `nvdiffrec_render`** — NVIDIA research code, governed by the
34
+ > **[NVIDIA Source Code License (1-Way Commercial)](https://github.com/NVlabs/nvdiffrast/blob/main/LICENSE.txt)**,
35
+ > which restricts use to **non-commercial research and evaluation**. That restriction
36
+ > applies to compiled binaries as much as to source. TRELLIS.2's own README carves these
37
+ > two out as "governed by its own License."
38
+ >
39
+ > **If your use is commercial, do not use the `nvdiffrast` or `nvdiffrec_render` wheels
40
+ > here.** Contact [NVIDIA Research Licensing](https://www.nvidia.com/en-us/research/inquiries/)
41
+ > instead. Mirroring these files does not grant you rights you wouldn't otherwise have, and
42
+ > nothing in this repo modifies NVIDIA's terms — read them yourself before you install.
43
+
44
+ ## What's here
45
+
46
+ | Package | Version | Python / Platform | Upstream | Licence |
47
+ |---|---|---|---|---|
48
+ | `cumesh` | 1.0 | cp311-win · cp312-win · cp312-linux | [TRELLIS.2](https://github.com/microsoft/TRELLIS.2) | MIT |
49
+ | `flex_gemm` | 0.0.1 | cp311-win · cp312-win · cp312-linux | [TRELLIS.2](https://github.com/microsoft/TRELLIS.2) | MIT |
50
+ | `o_voxel` | 0.0.1 | cp311-win · cp312-win · cp312-linux | [TRELLIS.2](https://github.com/microsoft/TRELLIS.2) | MIT |
51
+ | `nvdiffrast` | 0.4.0 | cp311-win · cp312-win · cp312-linux | [NVlabs](https://github.com/NVlabs/nvdiffrast) | **NVIDIA, non-commercial** |
52
+ | `nvdiffrec_render` | 0.0.0 | cp311-win · cp312-win · cp312-linux | [NVlabs](https://github.com/NVlabs/nvdiffrec) | **NVIDIA, non-commercial** |
53
+
54
+ What each one does:
55
+
56
+ - **CuMesh** — CUDA mesh processing: post-processing, remeshing, simplification, UV unwrapping
57
+ - **FlexGEMM** — Triton-based sparse convolution
58
+ - **O-Voxel** — conversion between textured meshes and the O-Voxel representation
59
+ - **nvdiffrast** — differentiable rasterisation, used to render the generated 3D assets
60
+ - **nvdiffrec_render** — split-sum renderer for PBR materials
61
+
62
+ Note that `cp311` is Windows-only here; `cp312` covers Windows and Linux.
63
+
64
+ ## Install
65
+
66
+ Match the wheel to your ComfyUI Python version. Check it first:
67
+
68
+ ```bash
69
+ python -c "import sys; print(sys.version)"
70
+ ```
71
+
72
+ Then install into the **same** environment ComfyUI uses — activate your venv first, or use
73
+ the portable build's embedded Python:
74
+
75
+ ```bash
76
+ # Windows, Python 3.12 — MIT-licensed components
77
+ pip install cumesh-1.0-cp312-cp312-win_amd64.whl
78
+ pip install flex_gemm-0.0.1-cp312-cp312-win_amd64.whl
79
+ pip install o_voxel-0.0.1-cp312-cp312-win_amd64.whl
80
+ ```
81
+
82
+ For ComfyUI portable, prefix with the embedded interpreter:
83
+
84
+ ```bash
85
+ python_embeded\python.exe -m pip install <wheel>
86
+ ```
87
+
88
+ Verify:
89
+
90
+ ```bash
91
+ python -c "import cumesh, flex_gemm, o_voxel; print('ok')"
92
+ ```
93
+
94
+ ### Troubleshooting
95
+
96
+ - **`is not a supported wheel on this platform`** — Python version mismatch. `cp311` wheels
97
+ require Python 3.11 and `cp312` requires 3.12. They are not interchangeable.
98
+ - **Imports fine in a terminal but ComfyUI can't find them** — you installed into the wrong
99
+ environment. ComfyUI portable does *not* use your system Python.
100
+ - **CUDA errors at runtime** — these are compiled extensions, so your installed PyTorch CUDA
101
+ build has to match. Check with `python -c "import torch; print(torch.version.cuda)"`.
102
+ - **Still stuck** — build from upstream source instead. That always works; it's just slow.
103
+
104
+ ## Guides
105
+
106
+ Full walkthroughs, including the ComfyUI node setup these wheels are for:
107
+
108
+ - [Microsoft TRELLIS 2 image-to-3D in ComfyUI](https://www.locallabdigest.com/blog/microsoft-trellis-2-3d-comfyui)
109
+ - [Hunyuan 3D in ComfyUI](https://www.locallabdigest.com/blog/hunyuan-3d-comfyui)
110
+
111
+ More local-AI guides at [locallabdigest.com](https://www.locallabdigest.com).
112
+
113
+ ## No warranty
114
+
115
+ Third-party compiled binaries, provided as-is, with no warranty of any kind. If running
116
+ precompiled CUDA extensions from someone else isn't acceptable in your situation, build from
117
+ upstream source. All credit for the underlying work belongs to the upstream authors listed
118
+ above.