ognn 1.0.0

Dual Octree Graph Neural Networks

Dual Octree Graph Networks

This repository contains the implementation of our papers Dual Octree Graph Networks. The experiments are conducted on Ubuntu 18.04 with 4 V400 GPUs (32GB memory). The code is released under the MIT license.

Dual Octree Graph Networks for Learning Adaptive Volumetric Shape Representations
Peng-Shuai Wang, Yang Liu, and Xin Tong
ACM Transactions on Graphics (SIGGRAPH), 41(4), 2022

• Dual Octree Graph Networks
  • 1. Installation
  • 2. Shape Reconstruction with ShapeNet
    • 2.1 Data Preparation
    • 2.2 Experiment
    • 2.3 Generalization
  • 3. Synthetic Scene Reconstruction
    • 3.1 Data Preparation
    • 3.2 Experiment
  • 4. Unsupervised Surface Reconstruction with DFaust
    • 4.1 Data Preparation
    • 4.2 Experiment
    • 4.3 Generalization
  • 5. Autoencoder with ShapeNet
    • 5.1 Data Preparation
    • 5.2 Experiment
  • 6. Citation

1. Installation

1. Install Conda and create a Conda environment.

   conda create --name ognn python=3.9
   conda activate ognn
   

2. Install PyTorch>=1.9.1 with conda according to the official documentation.

3. Clone this repository and install other requirements.

   git clone --recursive https://github.com/octree-nn/ognn-pytorch.git
   cd  ognn-pytorch
   pip install -r requirements.txt
   

2. Shape Reconstruction with ShapeNet

2.1 Data Preparation

1. Download ShapeNetCore.v1.zip (31G) from ShapeNet and place it into the folder data/ShapeNet.

2. Convert the meshes in ShapeNetCore.v1 to signed distance fields (SDFs).

   python tools/shapenet.py --run convert_mesh_to_sdf
   

   Note that this process is relatively slow, it may take several days to finish converting all the meshes from ShapeNet. And for simplicity, I did not use multiprocessing of Python to speed up. If the speed is a matter, you can simultaneously execute multiple Python commands manually by specifying the start and end index of the mesh to be processed. An example is shown as follows:

   python tools/shapenet.py --run convert_mesh_to_sdf --start 10000 --end 20000
   

   The ShapeNetConv.v1 contains 57k meshes. After unzipping, the total size is about 100G. The total sizes of the generated SDFs and the repaired meshes are 450G and 90G, respectively. Please make sure your hard disk has enough space.

3. Sample points and ground-truth SDFs for the learning process.

   python tools/shapenet.py --run generate_dataset
   

4. If you just want to forward the pre-trained network, the test point clouds (330M) can be downloaded manually from here. After downloading the zip file, unzip it to the folder data/ShapeNet/test.input.

2.2 Experiment

1. Train: Run the following command to train the network on 4 GPUs. The training takes 17 hours on 4 V100 GPUs. The trained weight and log can be downloaded here.

   python main.py  --config configs/shapenet.yaml SOLVER.gpu 0,1,2,3
   

2. Test: Run the following command to generate the extracted meshes. It is also possible to specify other trained weights by replacing the parameter after SOLVER.ckpt.

   python main.py --config configs/shapenet_eval.yaml  \
          SOLVER.ckpt logs/shapenet/shapenet/checkpoints/00300.model.pth
   

3. Evaluate: We use the code of ConvONet to compute the evaluation metrics. Following the instructions here to reproduce our results in Table 1.

2.3 Generalization

1. Test: Run the following command to test the trained network on unseen 5 categories of ShapeNet:

   python main.py --config configs/shapenet_unseen5.yaml  \
          SOLVER.ckpt logs/shapenet/shapenet/checkpoints/00300.model.pth
   

2. Evaluate: Following the instructions here to reproduce our results on the unseen dataset in Table 1.

3. Synthetic Scene Reconstruction

3.1 Data Preparation

Download and unzip the synthetic scene dataset (205G in total) and the data splitting file lists by ConvONet via the following command. If needed, the ground truth meshes can be downloaded from here (90G).

python tools/room.py --run generate_dataset

3.2 Experiment

1. Train: Run the following command to train the network on 4 GPUs. The training takes 27 hours on 4 V100 GPUs. The trained weight and log can be downloaded here.

   python main.py  --config configs/synthetic_room.yaml SOLVER.gpu 0,1,2,3
   

2. Test: Run the following command to generate the extracted meshes.

   python main.py --config configs/synthetic_room_eval.yaml  \
       SOLVER.ckpt logs/room/room/checkpoints/00900.model.pth
   

3. Evaluate: Following the instructions here to reproduce our results in Table 5.

4. Unsupervised Surface Reconstruction with DFaust

4.1 Data Preparation

1. Download the DFaust dataset, unzip the raw scans into the folder data/dfaust/scans, and unzip the ground-truth meshes into the folder data/dfaust/mesh_gt. Note that the ground-truth meshes are used in computing evaluation metrics and NOT used in training.

2. Run the following command to prepare the dataset.

   python tools/dfaust.py --run genereate_dataset
   

3. For convenience, we also provide the dataset for downloading.

   python tools/dfaust.py --run download_dataset
   

4.2 Experiment

1. Train: Run the following command to train the network on 4 GPUs. The training takes 20 hours on 4 V100 GPUs. The trained weight and log can be downloaded here.

   python main.py  --config configs/dfaust.yaml SOLVER.gpu 0,1,2,3
   

2. Test: Run the following command to generate the meshes with the trained weights.

   python main.py --config configs/dfaust_eval.yaml  \
          SOLVER.ckpt logs/dfaust/dfaust/checkpoints/00600.model.pth
   

3. Evaluate: To calculate the evaluation metric, we need first rescale the mesh into the original size, since the point clouds are scaled during the data processing stage.

   python tools/dfaust.py  \
          --mesh_folder   logs/dfaust_eval/dfaust  \
          --output_folder logs/dfaust_eval/dfaust_rescale  \
          --run rescale_mesh
   

   Then our results in Table 6 can be reproduced in the file metrics.csv.

   python tools/compute_metrics.py  \
          --mesh_folder logs/dfaust_eval/dfaust_rescale  \
          --filelist data/dfaust/filelist/test.txt  \
          --ref_folder data/dfaust/mesh_gt  \
          --filename_out logs/dfaust_eval/dfaust_rescale/metrics.csv
   

4.3 Generalization

In Figure 1 and 11 of our paper, we test the generalization ability of our network on several out-of-distribution point clouds. Please download the point clouds from here, and place the unzipped data to the folder data/shapes. Then run the following command to reproduce the results:

python main.py --config configs/shapes.yaml  \
       SOLVER.ckpt logs/dfaust/dfaust/checkpoints/00600.model.pth  \

5. Autoencoder with ShapeNet

5.1 Data Preparation

Following the instructions here to prepare the dataset.

5.2 Experiment

1. Train: Run the following command to train the network on 4 GPUs. The training takes 24 hours on 4 V100 GPUs. The trained weight and log can be downloaded here.

   python main.py  --config configs/shapenet_ae.yaml SOLVER.gpu 0,1,2,3
   

2. Test: Run the following command to generate the extracted meshes.

   python main.py --config configs/shapenet_ae_eval.yaml  \
          SOLVER.ckpt logs/shapenet/ae/checkpoints/00300.model.pth
   

3. Evaluate: Run the following command to evaluate the predicted meshes. Then our results in Table 7 can be reproduced in the file metrics.4096.csv.

   python tools/compute_metrics.py  \
          --mesh_folder logs/shapenet_eval/ae  \
          --filelist data/ShapeNet/filelist/test_im.txt \
          --ref_folder data/ShapeNet/mesh.test.im  \
          --num_samples 4096 \
          --filename_out logs/shapenet_eval/ae/metrics.4096.csv
   

6. Citation

@article {Wang-2022-main,
  title      = {Dual Octree Graph Networks
                for Learning Adaptive Volumetric Shape Representations},
  author     = {Wang, Peng-Shuai and Liu, Yang and Tong, Xin},
  journal    = {ACM Transactions on Graphics (SIGGRAPH)},
  volume     = {41},
  number     = {4},
  year       = {2022},
}