NVIDIA Kaolin library provides a PyTorch API for working with a variety of 3D representations and includes a growing collection of GPU-optimized operations such as modular differentiable rendering, fast conversions between representations, data loading, 3D checkpoints, differentiable camera API, differentiable lighting with spherical harmonics and spherical gaussians, powerful quadtree acceleration structure called Structured Point Clouds, interactive 3D visualizer for jupyter notebooks, convenient batched mesh container and more. Visit the Kaolin Library Documentation to get started!
Note that Kaolin library is part of the larger NVIDIA Kaolin effort for 3D deep learning.
Starting with v0.12.0, Kaolin supports installation with wheels:
# Replace TORCH_VERSION and CUDA_VERSION with your torch / cuda versions
pip install kaolin==0.12.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/torch-{TORCH_VERSION}_cu{CUDA_VERSION}.html
For example, to install kaolin 0.13.0 over torch 1.12.1 and cuda 11.3:
pip install kaolin==0.13.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/torch-1.12.1_cu113.html
We now support versions 0.12.0 to 0.14.0.
In this version we added a conversion Op for mesh to SPC, which allows turning meshes into Structured Point Cloud, our octree based representation. In addition, interactive 3D visualizers for Jupyter notebooks and a SurfaceMesh class (see tutorials below).
Check our new tutorials:
Bring any custom renderer into a Jupyter notebook for debugging. Use Kaolin Camera to navigate:
Read and manage batched mesh attributes with convenience using SurfaceMesh:
See change logs for details.
Please review our contribution guidelines.
- NVIDIA Kaolin Wisp:
- Use Camera API, Structured Point Clouds and its rendering capabilities
- gradSim: Differentiable simulation for system identification and visuomotor control:
- Use DIB-R rasterizer, obj loader and timelapse
- Learning to Predict 3D Objects with an Interpolation-based Differentiable Renderer:
- Use Kaolin's DIB-R rasterizer, camera functions and Timelapse for 3D checkpoints.
- Neural Geometric Level of Detail: Real-time Rendering with Implicit 3D Surfaces:
- Use SPC conversions and ray-tracing, yielding 30x memory and 3x training time reduction.
- Learning Deformable Tetrahedral Meshes for 3D Reconstruction:
- Text2Mesh:
- Use Kaolin's rendering functions, camera functions, and obj and off importers.
Most of Kaolin's repository is under Apache v2.0 license, except under kaolin/non_commercial which is under NSCL license restricted to non commercial usage for research and evaluation purposes. For example, FlexiCubes method is included under non_commercial.
Default kaolin import includes Apache-licensed components:
import kaolin
The non-commercial components need to be explicitly imported as:
import kaolin.non_commercial
If you are using Kaolin library for your research, please cite:
@misc{KaolinLibrary,
author = {Fuji Tsang, Clement and Shugrina, Maria and Lafleche, Jean Francois and Takikawa, Towaki and Wang, Jiehan and Loop, Charles and Chen, Wenzheng and Jatavallabhula, Krishna Murthy and Smith, Edward and Rozantsev, Artem and Perel, Or and Shen, Tianchang and Gao, Jun and Fidler, Sanja and State, Gavriel and Gorski, Jason and Xiang, Tommy and Li, Jianing and Li, Michael and Lebaredian, Rev},
title = {Kaolin: A Pytorch Library for Accelerating 3D Deep Learning Research},
year = {2022},
howpublished={\url{https://github.com/NVIDIAGameWorks/kaolin}}
}
Current Team:
- Technical Lead: Clement Fuji Tsang
- Manager: Maria (Masha) Shugrina
- Charles Loop
- Or Perel
- Alexander Zook
Other Majors Contributors:
- Wenzheng Chen
- Sanja Fidler
- Jun Gao
- Jason Gorski
- Jean-Francois Lafleche
- Rev Lebaredian
- Jianing Li
- Michael Li
- Krishna Murthy Jatavallabhula
- Artem Rozantsev
- Tianchang (Frank) Shen
- Edward Smith
- Gavriel State
- Towaki Takikawa
- Jiehan Wang
- Tommy Xiang