Skip to content

augmenta-ai/diffusion-net

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DiffusionNet is a general-purpose method for deep learning on surfaces such as 3D triangle meshes and point clouds. It is well-suited for tasks like segmentation, classification, feature extraction, etc.

Why try DiffusionNet?

  • It is efficient and scalable. On a single GPU, we can easily train on meshes of 20k vertices, and infer on meshes with 200k vertices. One-time preprocessing takes a few seconds in the former case, and about a minute in the latter.
  • It is sampling agnostic. Many graph-based mesh learning approaches tend to overfit to mesh connectivity, and can output nonsense when you run them on meshes that are triangulated differently from the training set. With DiffusionNet we can intermingle different triangulations and very coarse or fine meshes without issue. No special regularization or data augmentation needed!
  • It is representation agnostic. For instance, you can train on a mesh and infer on a point cloud, or mix meshes and point clouds in the training set.
  • It is robust. DiffusionNet avoids potentially-brittle geometric operations, and does not impose any assumptions such as manifoldness, etc.
  • It is data efficient. DiffusionNet can learn from 10s of models, even without any data augmentation.

DiffusionNet is described in the paper "DiffusionNet: Discretization Agnostic Learning on Surfaces", by

network diagram

Outline

  • diffusion_net/src implementation of the method, including preprocessing, layers, etc
  • experiments examples and scripts to reproduce experiments from the DiffusionNet paper
  • environment.yml A conda environment file which can be used to install packages.

Prerequisites

DiffusionNet depends on pytorch, as well as a handful of other fairly typical numerical packages. These can usually be installed manually without much trouble, but alternately a conda environment file is also provided (see conda documentation for additional instructions). These package versions were tested with CUDA 10.1 and 11.1.

conda env create --name diffusion_net -f environment.yml

The code assumes a GPU with CUDA support. DiffusionNet has minimal memory requirements; >4GB GPU memory should be sufficient.

Applying DiffusionNet to your task

The DiffusionNet class can be applied to meshes or point clouds. The basic recipe looks like:

import diffusion_net

# Here we use Nx3 positions as features. Any other features you might have will work!
# See our experiments for the use of of HKS features, which are naturally 
# invariant to (isometric) deformations.
C_in = 3

# Output dimension (e.g., for a 10-class segmentation problem)
C_out = 10 

# Create the model
model = diffusion_net.layers.DiffusionNet(
            C_in=C_in,
            C_out=n_class,
            C_width=128, # internal size of the diffusion net. 32 -- 512 is a reasonable range
            last_activation=lambda x : torch.nn.functional.log_softmax(x,dim=-1), # apply a last softmax to outputs 
                                                                                  # (set to default None to output general values in R^{N x C_out})
            outputs_at='vertices')

# An example epoch loop.
# For a dataloader example see experiments/human_segmentation_original/human_segmentation_original_dataset.py
for sample in your_dataset:
    
    verts = sample.vertices  # (Vx3 array of vertices)
    faces = sample.faces     # (Fx3 array of faces, None for point cloud) 
    
    # center and unit scale
    verts = diffusion_net.geometry.normalize_positions(verts)
    
    # Get the geometric operators needed to evaluate DiffusionNet. This routine 
    # automatically populates a cache, precomputing only if needed.
    # TIP: Do this once in a dataloader and store in memory to further improve 
    # performance; see examples.
    frames, mass, L, evals, evecs, gradX, gradY = \
        get_operators(verts, faces, op_cache_dir='my/cache/directory/')
    
    # this example uses vertex positions as features 
    features = verts
    
    # Forward-evaluate the model
    # preds is a NxC_out array of values
    outputs = model(features, mass, L=L, evals=evals, evecs=evecs, gradX=gradX, gradY=gradY, faces=faces)
    
    # Now do whatever you want! Apply your favorite loss function, 
    # backpropgate with loss.backward() to train the DiffusionNet, etc. 

See the examples in experiments/ for complete examples, including dataloaders, other features, optimizers, etc. Please feel free to file an issue to discuss applying DiffusionNet to your problem!

BIM Element Classification

The BIM classification experiment treats each BIM element as one mesh sample.

Data

The data directory must contain train and test splits, with one directory per study:

DATA_DIR/
  train/
    study_a/
      bim_graph.json
      mesh_faces.bin
      mesh_verts.bin
  test/
    study_b/
      bim_graph.json
      mesh_faces.bin
      mesh_verts.bin

Each study contains column-major int32 triangle indices in mesh_faces.bin, column-major float32 XYZ coordinates in mesh_verts.bin, and element categories and face ranges in bim_graph.json.

Preparing Data

Remove repeated rigid instances from each split before training:

python experiments/classification_agmt/main.py prepare \
  --input_dir=/path/to/source/train \
  --output_dir=/path/to/prepared/train

python experiments/classification_agmt/main.py prepare \
  --input_dir=/path/to/source/test \
  --output_dir=/path/to/prepared/test

Preparation keeps the first mesh in sorted study and graph order for each category and geometric fingerprint, then rewrites compact study graphs and binary geometry buffers. The fingerprint is invariant to translation, rotation, vertex order, face order, and triangle winding. It combines vertex and face counts with sorted, quantized centroid-to-vertex distances and triangle edge lengths. Scale changes remain distinct, while reflected copies match. The default absolute tolerance is 1e-3 feet; override it with --position_tolerance. Train and test must be prepared separately so no sample selection crosses the split boundary.

The output directory must be empty. Each run writes prepare_summary.json with overall and per-category counts.

Training

python experiments/classification_agmt/main.py train \
  --data_dir=/path/to/data \
  --output_dir=runs/agmt_diffusionnet \
  --config=/path/to/hyperparameters.json

The config controls model and optimization settings. Omitted values use these defaults:

{
  "input_features": "hks",
  "max_epoch": 200,
  "learning_rate": 0.001,
  "weight_decay": 0.000001,
  "label_smoothing": 0.0,
  "k_eig": 128,
  "width": 64,
  "blocks": 4,
  "dropout": true,
  "num_workers": 0,
  "seed": 42,
  "scheduler_gamma": 0.98
}

Without --config, training checks /opt/ml/input/config/hyperparameters.json and otherwise uses the defaults. Set input_features to xyz for coordinate features with random rotation augmentation; the default hks features are intrinsic.

Categories default to the sorted union found in both splits. Restrict them with --target_categories pointing to a JSON list or an object containing a targets list.

Training uses one mesh per optimizer step because mesh operators have different dimensions. The output directory contains the operator cache, resolved class list, and last.pt and best.pt. Resume with:

python experiments/classification_agmt/main.py train \
  --data_dir=/path/to/data \
  --output_dir=runs/agmt_diffusionnet \
  --checkpoint=runs/agmt_diffusionnet/last.pt

Container

The Dockerfile provides a devcontainer target for VS Code and a runnable main target:

docker build --target devcontainer -f .devcontainer/Dockerfile -t diffusion-net-dev .
docker build --target main -f .devcontainer/Dockerfile -t diffusion-net .

Run training by mounting the data, output directory, and config:

docker run --rm --gpus all \
  -v /path/to/data:/data:ro \
  -v /path/to/output:/output \
  -v /path/to/hyperparameters.json:/config/hyperparameters.json:ro \
  diffusion-net train --data_dir=/data --output_dir=/output \
  --config=/config/hyperparameters.json

Tips and Tricks

By default, DiffusionNet uses spectral acceleration for fast performance, which requires some CPU-based precomputation to compute operators & eigendecompositions for each input, which can take a few seconds for moderately sized inputs. DiffusionNet will be fastest if this precomputation only needs to be performed once for the dataset, rather than for each input.

  • If you are learning on a template mesh, consider precomputing operators for the reference pose of the template, but then using xyz the coordinates of the deformed pose as inputs to the network. This is a slight approximation, but will make DiffusionNet very fast, since the precomputed operators are shared among all poses.
  • If you need data augmentation, try to apply augmentations after computing operators whenever possible. For instance, in our examples, we apply random rotation to positions, but only after computing operators. Note that we find common augmentations such as slightly skewing/scaling/subsampling inputs are generally unnecessary with DiffusionNet.

Thanks

Parts of this work were generously supported by the Fields Institute for Mathematics, the Vector Institute, ERC Starting Grant No. 758800 (EXPROTEA) the ANR AI Chair AIGRETTE, a Packard Fellowship, NSF CAREER Award 1943123, an NSF Graduate Research Fellowship, and gifts from Activision Blizzard, Adobe, Disney, Facebook, and nTopology. The dataset loaders mimic code from HSN, pytorch-geometric, and probably indirectly from other sources too. Thank you!

About

Pytorch implementation of DiffusionNet for fast and robust learning on 3D surfaces like meshes or point clouds.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages