News

[02/2025] 3DTopia-XL is accepted to CVPR 2025 :fire:

[02/2025] Training code released!

[10/2024] WiseModel demo released!

[09/2024] Technical report released!

[09/2024] Hugging Face demo released!

[09/2024] Inference code released!

Citation

If you find our work useful for your research, please consider citing this paper:

@inproceedings{chen2025primx,
  title={3DTopia-XL: High-Quality 3D PBR Asset Generation via Primitive Diffusion},
  author={Chen, Zhaoxi and Tang, Jiaxiang and Dong, Yuhao and Cao, Ziang and Hong, Fangzhou and Lan, Yushi and Wang, Tengfei and Xie, Haozhe and Wu, Tong and Saito, Shunsuke and Pan, Liang and Lin, Dahua and Liu, Ziwei},
  booktitle={CVPR},
  year={2025}
}

:gear: Installation

We highly recommend using Anaconda to manage your python environment. You can setup the required environment by the following commands:

# install dependencies
conda create -n primx python=3.9
conda install pytorch==2.1.2 torchvision==0.16.2 torchaudio==2.1.2 pytorch-cuda=11.8 -c pytorch -c nvidia
# requires xformer for efficient attention
conda install xformers::xformers
# install other dependencies
pip install -r requirements.txt
# compile third party libraries
bash install.sh
# Now, all done!

For proper glTF texture and material packing, fix a bug in Trimesh (trimesh.visual.gloss.specular_to_pbr #L361) if you are using old version:

    result["metallicRoughnessTexture"] = toPIL(
        np.concatenate(
            [np.zeros_like(metallic), 1.0 - glossiness, metallic], axis=-1
        ),
        mode="RGB",
    )

:muscle: Pretrained Weights

Our pretrained weight can be downloaded from huggingface

For example, to download the singleview-conditioned model in fp16 precision for inference:

mkdir pretrained && cd pretrained
# download DiT
wget https://huggingface.co/FrozenBurning/3DTopia-XL/resolve/main/model_sview_dit_fp16.pt
# download VAE
wget https://huggingface.co/FrozenBurning/3DTopia-XL/resolve/main/model_vae_fp16.pt
cd ..

For text-conditioned model, please download from this Google Drive We put out text conditioner in models/conditioner/text.py. Please download the specific version of text conditioner as follows:

cd pretrained
wget https://huggingface.co/laion/CLIP-ViT-L-14-DataComp.XL-s13B-b90K/resolve/main/open_clip_pytorch_model.bin\?download\=true
cd ..

:rocket: Inference

Gradio Demo

The gradio demo will automatically download pretrained weights using huggingface_hub.

You could locally launch our demo with Gradio UI by:

python app.py

Alternatively, you can run the demo online

CLI Test

Run the following command for inference:

python inference.py ./configs/inference_dit.yml

Furthermore, you can modify the inference parameters in inference_dit.yml, detailed as follows:

Parameter	Recommended	Description
input_dir	-	The path of folder that stores all input images.
ddim	25, 50, 100	Total number of DDIM steps. Robust with more steps but fast with fewer steps.
cfg	4 - 7	The scale for Classifer-free Guidance (CFG).
seed	Any	Different seeds lead to diverse different results.
export_glb	True	Whether to export textured mesh in GLB format after DDIM sampling is over.
fast_unwrap	False	Whether to enable fast UV unwrapping algorithm.
decimate	100000	The max number of faces for mesh extraction.
mc_resolution	256	The resolution of the unit cube for marching cube.
remesh	False	Whether to run retopology after mesh extraction.

By changing the config to inference_dit_text.yml and update the image encoding process to text encoding in the inference script, you will get the text-to-3D generation pipeline.

:hotsprings: Training

Data Preparation and Mesh2PrimX

Raw data: Textured Mesh

We train our model on a subset of Objaverse dataset. Please refer to the list where each entry is stored as {folder}/{uid}.

Raw data: Captions

Our captions can be downloaded from this Google Drive.

Tensorize meshes into PrimX

The first step before training is to converting all textured meshes (glTF format) into PrimX representation (NxD tensor):

# this only fit one single mesh defined as dataset.mesh_file_path
python train_fitting.py configs/train_fitting.yml

The above command only fit a single textured mesh whose path is defined as dataset.mesh_file_path in the config file. It can be easily scaled up to the fullset with a parallel fitting pipeline.

The following comparisons illustrate the quality of high-quality tokenization by PrimX:

VAE Training

To train the VAE for Primitive Patch Compression, run the following command:

torchrun --nnodes=1 --nproc_per_node=8 train_vae.py configs/train_vae.yml

By default, the VAE training relies on PrimX fittings from previous stage whose path template is defined as dataset.manifold_url_template in the config file.

DiT Training

Before the DiT training, we suggest to cache all condition features and VAE features:

# vae cache, which will use the vae checkpoint as model.vae_checkpoint_path
python scripts/cache_vae.py configs/train_dit.yml
# condition cache
python scripts/cache_conditioner.py configs/train_dit.yml

Once caching is done, training DiT for conditional 3D generation can be launched as follows:

torchrun --nnodes=1 --nproc_per_node=8 train_dit.py configs/train_dit.yml

Acknowledgement

This work is built on many amazing research works and open-source projects, thanks all the authors for sharing!

• PrimDiffusion
• MVP
• DiT
• nvdiffrast
• kiuikit
• Trimesh
• litmodel3d