API Overview

Below is a summary of Kaolin functionality. Refer to Tutorial Index for specific use cases, examples and recipes that use these building blocks.

Operators for 3D Data:

kaolin/ops contains operators for efficient processing functions of batched 3d models and tensors. We provide, conversions between 3d representations, primitives batching of heterogenenous data, and efficient mainstream functions on meshes and voxelgrids.

• kaolin.ops
  • kaolin.ops.batch
  • kaolin.ops.coords
  • kaolin.ops.conversions
  • kaolin.ops.gcn
  • kaolin.ops.mesh
  • kaolin.ops.random
  • kaolin.ops.reduction
  • kaolin.ops.spc
  • kaolin.ops.voxelgrid

I/O:

kaolin/io contains functionality to interact with files.

We provide, importers and exporters to popular format such as .obj and .usd, but also utility functions and classes to preprocess and cache datasets with specific transforms.

• kaolin.io
  • kaolin.io.dataset
  • kaolin.io.materials
  • kaolin.io.obj
  • kaolin.io.off
  • kaolin.io.render
  • kaolin.io.shapenet
  • kaolin.io.usd
  • kaolin.io.modelnet
  • kaolin.io.shrec
  • kaolin.io.utils

Metrics:

kaolin/metrics contains functions to compute distance and losses such as point_to_mesh distance, chamfer distance, IoU, or laplacian smoothing.

• kaolin.metrics
  • kaolin.metrics.pointcloud
  • kaolin.metrics.render
  • kaolin.metrics.trianglemesh
  • kaolin.metrics.voxelgrid
  • kaolin.metrics.tetmesh

Differentiable Rendering:

kaolin/render provide functions related to differentiable rendering, such a DIB-R rasterization, application of camera projection / translation / rotation, lighting, and textures.

• kaolin.render
  • kaolin.render.camera
  • kaolin.render.lighting
  • kaolin.render.mesh
  • kaolin.render.spc

3D Checkpoints and Visualization:

kaolin/visualize contains utilities for writing 3D checkpoints for visualization. Currently we provide timelapse exporter that can be quickly picked up by the Omniverse Kaolin App.

• kaolin.visualize
  • API

Utilities:

kaolin/utils contains utility functions to help development of application or research scripts. We provide functions to display and check informations about tensors, and features to fix seed.

• kaolin.utils
  • kaolin.utils.testing