Skip to content

Install.md

Latest commit

 

History

History
100 lines (66 loc) · 2.98 KB

Install.md

File metadata and controls

100 lines (66 loc) · 2.98 KB

Installation Guide

Quick Reference

Model Required Steps
TRELLIS (base) Steps 1-3
Hunyuan3D-2.0 (⭐ recommended) Steps 1-3, 4
TripoSG Steps 1-3, 5
Craftsman3D Steps 1-3, 5, 6

Prerequisites

Pytorch Installation

Please install Pytorch with CUDA support. You can find the installation instructions on the Pytorch website.

Our program has been tested with Python 3.10 + Pytorch 2.4.0 + CUDA 12.1.

Base Installation (Required for All Models)

Steps 1-3 are required regardless of which model you plan to use. After completing these steps, you will be able to use the TRELLIS model (base option).

Step 1: Base Environment Setup

Details of the arguments can be found in TRELLIS-Page:

. ./setup.sh --basic --xformers --flash-attn --diffoctreerast --spconv --mipgaussian --kaolin --nvdiffrast

Step 2: Install Additional Python Packages

pip install -r requirements.txt

# (for TRELLIS mesh extractor)
pip install kaolin==0.17.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/torch-{TORCH_VER}_cu{CUDA_VER}.html 

# (for HDR imageio read)
imageio_download_bin freeimage

Step 3: Install Blender for 4D Asset Conversion

Please follow the instructions on the Blender website to install Blender.

Our program has been tested with blender-4.2.1-linux-x64.

Optional Model-Specific Installation

After completing the base installation (Steps 1-3), you can optionally install additional dependencies based on which models you want to use:

Step 4: Setup for Hunyuan3D-2.0 (Recommended ⭐)

Install this if you want to use Hunyuan3D-2.0 (our most recommended model):

# for texture
cd hy3dgen/texgen/custom_rasterizer
python3 setup.py install
cd ../../..
cd hy3dgen/texgen/differentiable_renderer
python3 setup.py install

Step 5: Setup for TripoSG

Install this if you want to use TripoSG (TripoSG texture requires glibc 2.34 which is default in Ubuntu 22.04 (Ubuntu 20.04 needs to manually install it)):

# Install Tripo-SG related models' checkpoints
cd tripoSG
python -m tripoSG.app

# (for Tripo-SG MVAdapter)
pip install spandrel==0.4.1 --no-deps 
pip install cvcuda-cu12
pip install pymeshlab==2022.2.post4
pip install tripoSG/diso-0.1.4-cp310-cp310-linux_x86_64.whl

Step 6: Setup for Craftsman3D

Install this if you want to use Craftsman3D (requires Step 5 to be completed first, as we use TripoSG's texture generation for Craftsman3D):

pip install lightning-utilities==0.11.2 pytorch-lightning==2.2.4 wandb typeguard open3d

cd models/checkpoints
mkdir craftsman-DoraVAE && cd craftsman-DoraVAE
wget https://pub-c7137d332b4145b6b321a6c01fcf8911.r2.dev/craftsman-DoraVAE/config.yaml
wget https://pub-c7137d332b4145b6b321a6c01fcf8911.r2.dev/craftsman-DoraVAE/model.ckpt