facebookresearch/SparseConvNet facebookresearch/SparseConvNet

  • Stars
    star
    1,847
  • Rank 24,098 (Top 0.5 %)
  • Language
    C++
  • License
    Other
  • Created almost 7 years ago
  • Updated 11 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
facebookresearch/SparseConvNet
github

facebookresearch

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Submanifold sparse convolutional networks

Submanifold Sparse Convolutional Networks

Support Ukraine

This is the PyTorch library for training Submanifold Sparse Convolutional Networks.

Spatial sparsity

This library brings Spatially-sparse convolutional networks to PyTorch. Moreover, it introduces Submanifold Sparse Convolutions, that can be used to build computationally efficient sparse VGG/ResNet/DenseNet-style networks.

With regular 3x3 convolutions, the set of active (non-zero) sites grows rapidly:
submanifold
With Submanifold Sparse Convolutions, the set of active sites is unchanged. Active sites look at their active neighbors (green); non-active sites (red) have no computational overhead:
submanifold
Stacking Submanifold Sparse Convolutions to build VGG and ResNet type ConvNets, information can flow along lines or surfaces of active points.

Disconnected components don't communicate at first, although they will merge due to the effect of strided operations, either pooling or convolutions. Additionally, adding ConvolutionWithStride2-SubmanifoldConvolution-DeconvolutionWithStride2 paths to the network allows disjoint active sites to communicate; see the 'VGG+' networks in the paper.
Strided Convolution, convolution, deconvolution
Strided Convolution, convolution, deconvolution
From left: (i) an active point is highlighted; a convolution with stride 2 sees the green active sites (ii) and produces output (iii), 'children' of hightlighted active point from (i) are highlighted; a submanifold sparse convolution sees the green active sites (iv) and produces output (v); a deconvolution operation sees the green active sites (vi) and produces output (vii).

Dimensionality and 'submanifolds'

SparseConvNet supports input with different numbers of spatial/temporal dimensions. Higher dimensional input is more likely to be sparse because of the 'curse of dimensionality'.

Dimension Name in 'torch.nn' Use cases
1 Conv1d Text, audio
2 Conv2d Lines in 2D space, e.g. handwriting
3 Conv3d Lines and surfaces in 3D space or (2+1)D space-time
4 - Lines, etc, in (3+1)D space-time

We use the term 'submanifold' to refer to input data that is sparse because it has a lower effective dimension than the space in which it lives, for example a one-dimensional curve in 2+ dimensional space, or a two-dimensional surface in 3+ dimensional space.

In theory, the library supports up to 10 dimensions. In practice, ConvNets with size-3 SVC convolutions in dimension 5+ may be impractical as the number of parameters per convolution is growing exponentially. Possible solutions include factorizing the convolutions (e.g. 3x1x1x..., 1x3x1x..., etc), or switching to a hyper-tetrahedral lattice (see Sparse 3D convolutional neural networks).

Hello World

SparseConvNets can be built either by defining a function that inherits from torch.nn.Module or by stacking modules in a sparseconvnet.Sequential:

import torch
import sparseconvnet as scn

# Use the GPU if there is one, otherwise CPU
device = 'cuda:0' if torch.cuda.is_available() else 'cpu'

model = scn.Sequential().add(
    scn.SparseVggNet(2, 1,
                     [['C', 8], ['C', 8], ['MP', 3, 2],
                      ['C', 16], ['C', 16], ['MP', 3, 2],
                      ['C', 24], ['C', 24], ['MP', 3, 2]])
).add(
    scn.SubmanifoldConvolution(2, 24, 32, 3, False)
).add(
    scn.BatchNormReLU(32)
).add(
    scn.SparseToDense(2, 32)
).to(device)

# output will be 10x10
inputSpatialSize = model.input_spatial_size(torch.LongTensor([10, 10]))
input_layer = scn.InputLayer(2, inputSpatialSize)

msgs = [[" X   X  XXX  X    X    XX     X       X   XX   XXX   X    XXX   ",
         " X   X  X    X    X   X  X    X       X  X  X  X  X  X    X  X  ",
         " XXXXX  XX   X    X   X  X    X   X   X  X  X  XXX   X    X   X ",
         " X   X  X    X    X   X  X     X X X X   X  X  X  X  X    X  X  ",
         " X   X  XXX  XXX  XXX  XX       X   X     XX   X  X  XXX  XXX   "],

        [" XXX              XXXXX      x   x     x  xxxxx  xxx ",
         " X  X  X   XXX       X       x   x x   x  x     x  x ",
         " XXX                X        x   xxxx  x  xxxx   xxx ",
         " X     X   XXX       X       x     x   x      x    x ",
         " X     X          XXXX   x   x     x   x  xxxx     x ",]]


# Create Nx3 and Nx1 vectors to encode the messages above:
locations = []
features = []
for batchIdx, msg in enumerate(msgs):
    for y, line in enumerate(msg):
        for x, c in enumerate(line):
            if c == 'X':
                locations.append([y, x, batchIdx])
                features.append([1])
locations = torch.LongTensor(locations)
features = torch.FloatTensor(features).to(device)

input = input_layer([locations,features])
print('Input SparseConvNetTensor:', input)
output = model(input)

# Output is 2x32x10x10: our minibatch has 2 samples, the network has 32 output
# feature planes, and 10x10 is the spatial size of the output.
print('Output SparseConvNetTensor:', output)

Examples

Examples in the examples folder include

For example:

cd examples/Assamese_handwriting
python VGGplus.py

Setup

Tested with PyTorch 1.3, CUDA 10.0, and Python 3.3 with Conda.

conda install pytorch torchvision cudatoolkit=10.0 -c pytorch # See https://pytorch.org/get-started/locally/
git clone [email protected]:facebookresearch/SparseConvNet.git
cd SparseConvNet/
bash develop.sh

To run the examples you may also need to install unrar:

apt-get install unrar

License

SparseConvNet is BSD licensed, as found in the LICENSE file. Terms of use. Privacy

Copyright © Meta Platforms, Inc

Links

  1. ICDAR 2013 Chinese Handwriting Recognition Competition 2013 First place in task 3, with test error of 2.61%. Human performance on the test set was 4.81%. Report
  2. Spatially-sparse convolutional neural networks, 2014 SparseConvNets for Chinese handwriting recognition
  3. Fractional max-pooling, 2014 A SparseConvNet with fractional max-pooling achieves an error rate of 3.47% for CIFAR-10.
  4. Sparse 3D convolutional neural networks, BMVC 2015 SparseConvNets for 3D object recognition and (2+1)D video action recognition.
  5. Kaggle plankton recognition competition, 2015 Third place. The competition solution is being adapted for research purposes in EcoTaxa.
  6. Kaggle Diabetic Retinopathy Detection, 2015 First place in the Kaggle Diabetic Retinopathy Detection competition.
  7. SparseConvNet 'classic' version
  8. Submanifold Sparse Convolutional Networks, 2017 Introduces deep 'submanifold' SparseConvNets.
  9. Workshop on Learning to See from 3D Data, 2017 First place in the semantic segmentation competition. Report
  10. 3D Semantic Segmentation with Submanifold Sparse Convolutional Networks, 2017 Semantic segmentation for the ShapeNet Core55 and NYU-DepthV2 datasets, CVPR 2018
  11. Unsupervised learning with sparse space-and-time autoencoders (3+1)D space-time autoencoders
  12. ScanNet 3D semantic label benchmark 2018 0.726 average IOU for 3D semantic segmentation.
  13. MinkowskiEngine is an alternative implementation of SparseConvNet; 0.736 average IOU for ScanNet.
  14. SpConv: PyTorch Spatially Sparse Convolution Library is an alternative implementation of SparseConvNet.
  15. Live Semantic 3D Perception for Immersive Augmented Reality describes a way to optimize memory access for SparseConvNet.
  16. OccuSeg real-time object detection using SparseConvNets.
  17. TorchSparse implements 3D submanifold convolutions.
  18. TensorFlow 3D implements submanifold convolutions.
  19. VoTr implements submanifold voxel transformers using SpConv.
  20. Mix3D brings MixUp to the sparse setting—0.781 average IOU for ScanNet 3D semantic segmentation.

Citations

If you find this code useful in your research then please cite:

3D Semantic Segmentation with Submanifold Sparse Convolutional Networks, CVPR 2018
Benjamin Graham,
Martin Engelcke,
Laurens van der Maaten, 

@article{3DSemanticSegmentationWithSubmanifoldSparseConvNet,
  title={3D Semantic Segmentation with Submanifold Sparse Convolutional Networks},
  author={Graham, Benjamin and Engelcke, Martin and van der Maaten, Laurens},
  journal={CVPR},
  year={2018}
}

and/or

Submanifold Sparse Convolutional Networks, https://arxiv.org/abs/1706.01307
Benjamin Graham,
Laurens van der Maaten, 

@article{SubmanifoldSparseConvNet,
  title={Submanifold Sparse Convolutional Networks},
  author={Graham, Benjamin and van der Maaten, Laurens},
  journal={arXiv preprint arXiv:1706.01307},
  year={2017}
}

More Repositories

1

llama

Inference code for LLaMA models
Python
44,989
star
2

segment-anything

The repository provides code for running inference with the SegmentAnything Model (SAM), links for downloading the trained model checkpoints, and example notebooks that show how to use the model.
Jupyter Notebook
42,134
star
3

Detectron

FAIR's research platform for object detection research, implementing popular algorithms like Mask R-CNN and RetinaNet.
Python
25,771
star
4

fairseq

Facebook AI Research Sequence-to-Sequence Toolkit written in Python.
Python
25,718
star
5

detectron2

Detectron2 is a platform for object detection, segmentation and other visual recognition tasks.
Python
25,567
star
6

fastText

Library for fast text representation and classification.
HTML
24,973
star
7

faiss

A library for efficient similarity search and clustering of dense vectors.
C++
24,035
star
8

audiocraft

Audiocraft is a library for audio processing and generation with deep learning. It features the state-of-the-art EnCodec audio compressor / tokenizer, along with MusicGen, a simple and controllable music generation LM with textual and melodic conditioning.
Python
18,693
star
9

codellama

Inference code for CodeLlama models
Python
13,303
star
10

detr

End-to-End Object Detection with Transformers
Python
11,076
star
11

ParlAI

A framework for training and evaluating AI models on a variety of openly available dialogue datasets.
Python
10,085
star
12

seamless_communication

Foundational Models for State-of-the-Art Speech and Text Translation
Jupyter Notebook
9,653
star
13

maskrcnn-benchmark

Fast, modular reference implementation of Instance Segmentation and Object Detection algorithms in PyTorch.
Python
9,104
star
14

pifuhd

High-Resolution 3D Human Digitization from A Single Image.
Python
8,923
star
15

hydra

Hydra is a framework for elegantly configuring complex applications
Python
8,044
star
16

AnimatedDrawings

Code to accompany "A Method for Animating Children's Drawings of the Human Figure"
Python
8,032
star
17

ImageBind

ImageBind One Embedding Space to Bind Them All
Python
7,630
star
18

nougat

Implementation of Nougat Neural Optical Understanding for Academic Documents
Python
7,568
star
19

llama-recipes

Scripts for fine-tuning Llama2 with composable FSDP & PEFT methods to cover single/multi-node GPUs. Supports default & custom datasets for applications such as summarization & question answering. Supporting a number of candid inference solutions such as HF TGI, VLLM for local or cloud deployment.Demo apps to showcase Llama2 for WhatsApp & Messenger
Jupyter Notebook
7,402
star
20

pytorch3d

PyTorch3D is FAIR's library of reusable components for deep learning with 3D data
Python
7,322
star
21

dinov2

PyTorch code and models for the DINOv2 self-supervised learning method.
Jupyter Notebook
7,278
star
22

DensePose

A real-time approach for mapping all human pixels of 2D RGB images to a 3D surface-based model of the body
Jupyter Notebook
6,547
star
23

pytext

A natural language modeling framework based on PyTorch
Python
6,357
star
24

metaseq

Repo for external large-scale work
Python
5,947
star
25

demucs

Code for the paper Hybrid Spectrogram and Waveform Source Separation
Python
5,886
star
26

SlowFast

PySlowFast: video understanding codebase from FAIR for reproducing state-of-the-art video models.
Python
5,678
star
27

mae

PyTorch implementation of MAE https//arxiv.org/abs/2111.06377
Python
5,495
star
28

mmf

A modular framework for vision & language multimodal research from Facebook AI Research (FAIR)
Python
5,235
star
29

ConvNeXt

Code release for ConvNeXt model
Python
4,971
star
30

dino

PyTorch code for Vision Transformers training with the Self-Supervised learning method DINO
Python
4,830
star
31

DiT

Official PyTorch Implementation of "Scalable Diffusion Models with Transformers"
Python
4,761
star
32

AugLy

A data augmentations library for audio, image, text, and video.
Python
4,739
star
33

Kats

Kats, a kit to analyze time series data, a lightweight, easy-to-use, generalizable, and extendable framework to perform time series analysis, from understanding the key statistics and characteristics, detecting change points and anomalies, to forecasting future trends.
Python
4,387
star
34

DrQA

Reading Wikipedia to Answer Open-Domain Questions
Python
4,374
star
35

xformers

Hackable and optimized Transformers building blocks, supporting a composable construction.
Python
4,191
star
36

moco

PyTorch implementation of MoCo: https://arxiv.org/abs/1911.05722
Python
4,035
star
37

StarSpace

Learning embeddings for classification, retrieval and ranking.
C++
3,856
star
38

fairseq-lua

Facebook AI Research Sequence-to-Sequence Toolkit
Lua
3,765
star
39

nevergrad

A Python toolbox for performing gradient-free optimization
Python
3,446
star
40

deit

Official DeiT repository
Python
3,425
star
41

dlrm

An implementation of a deep learning recommendation model (DLRM)
Python
3,417
star
42

ReAgent

A platform for Reasoning systems (Reinforcement Learning, Contextual Bandits, etc.)
Python
3,395
star
43

LASER

Language-Agnostic SEntence Representations
Python
3,308
star
44

VideoPose3D

Efficient 3D human pose estimation in video using 2D keypoint trajectories
Python
3,294
star
45

PyTorch-BigGraph

Generate embeddings from large-scale graph-structured data.
Python
3,238
star
46

deepmask

Torch implementation of DeepMask and SharpMask
Lua
3,113
star
47

MUSE

A library for Multilingual Unsupervised or Supervised word Embeddings
Python
3,094
star
48

vissl

VISSL is FAIR's library of extensible, modular and scalable components for SOTA Self-Supervised Learning with images.
Jupyter Notebook
3,038
star
49

pytorchvideo

A deep learning library for video understanding research.
Python
2,885
star
50

XLM

PyTorch original implementation of Cross-lingual Language Model Pretraining.
Python
2,763
star
51

hiplot

HiPlot makes understanding high dimensional data easy
TypeScript
2,481
star
52

ijepa

Official codebase for I-JEPA, the Image-based Joint-Embedding Predictive Architecture. First outlined in the CVPR paper, "Self-supervised learning from images with a joint-embedding predictive architecture."
Python
2,381
star
53

fairscale

PyTorch extensions for high performance and large scale training.
Python
2,319
star
54

audio2photoreal

Code and dataset for photorealistic Codec Avatars driven from audio
Python
2,316
star
55

encodec

State-of-the-art deep learning based audio codec supporting both mono 24 kHz audio and stereo 48 kHz audio.
Python
2,313
star
56

habitat-sim

A flexible, high-performance 3D simulator for Embodied AI research.
C++
2,299
star
57

InferSent

InferSent sentence embeddings
Jupyter Notebook
2,264
star
58

co-tracker

CoTracker is a model for tracking any point (pixel) on a video.
Jupyter Notebook
2,240
star
59

Pearl

A Production-ready Reinforcement Learning AI Agent Library brought by the Applied Reinforcement Learning team at Meta.
Python
2,193
star
60

pyrobot

PyRobot: An Open Source Robotics Research Platform
Python
2,109
star
61

darkforestGo

DarkForest, the Facebook Go engine.
C
2,108
star
62

ELF

An End-To-End, Lightweight and Flexible Platform for Game Research
C++
2,089
star
63

pycls

Codebase for Image Classification Research, written in PyTorch.
Python
2,053
star
64

esm

Evolutionary Scale Modeling (esm): Pretrained language models for proteins
Python
2,026
star
65

frankmocap

A Strong and Easy-to-use Single View 3D Hand+Body Pose Estimator
Python
1,972
star
66

video-nonlocal-net

Non-local Neural Networks for Video Classification
Python
1,931
star
67

SentEval

A python tool for evaluating the quality of sentence embeddings.
Python
1,930
star
68

ResNeXt

Implementation of a classification framework from the paper Aggregated Residual Transformations for Deep Neural Networks
Lua
1,863
star
69

swav

PyTorch implementation of SwAV https//arxiv.org/abs/2006.09882
Python
1,790
star
70

TensorComprehensions

A domain specific language to express machine learning workloads.
C++
1,747
star
71

Mask2Former

Code release for "Masked-attention Mask Transformer for Universal Image Segmentation"
Python
1,638
star
72

habitat-lab

A modular high-level library to train embodied AI agents across a variety of tasks and environments.
Python
1,636
star
73

fvcore

Collection of common code that's shared among different research projects in FAIR computer vision team.
Python
1,623
star
74

TransCoder

Public release of the TransCoder research project https://arxiv.org/pdf/2006.03511.pdf
Python
1,611
star
75

poincare-embeddings

PyTorch implementation of the NIPS-17 paper "Poincaré Embeddings for Learning Hierarchical Representations"
Python
1,587
star
76

votenet

Deep Hough Voting for 3D Object Detection in Point Clouds
Python
1,563
star
77

pytorch_GAN_zoo

A mix of GAN implementations including progressive growing
Python
1,554
star
78

ClassyVision

An end-to-end PyTorch framework for image and video classification
Python
1,552
star
79

deepcluster

Deep Clustering for Unsupervised Learning of Visual Features
Python
1,544
star
80

higher

higher is a pytorch library allowing users to obtain higher order gradients over losses spanning training loops rather than individual training steps.
Python
1,524
star
81

UnsupervisedMT

Phrase-Based & Neural Unsupervised Machine Translation
Python
1,496
star
82

consistent_depth

We estimate dense, flicker-free, geometrically consistent depth from monocular video, for example hand-held cell phone video.
Python
1,479
star
83

Detic

Code release for "Detecting Twenty-thousand Classes using Image-level Supervision".
Python
1,446
star
84

end-to-end-negotiator

Deal or No Deal? End-to-End Learning for Negotiation Dialogues
Python
1,368
star
85

multipathnet

A Torch implementation of the object detection network from "A MultiPath Network for Object Detection" (https://arxiv.org/abs/1604.02135)
Lua
1,349
star
86

CommAI-env

A platform for developing AI systems as described in A Roadmap towards Machine Intelligence - http://arxiv.org/abs/1511.08130
1,324
star
87

theseus

A library for differentiable nonlinear optimization
Python
1,306
star
88

ConvNeXt-V2

Code release for ConvNeXt V2 model
Python
1,300
star
89

DPR

Dense Passage Retriever - is a set of tools and models for open domain Q&A task.
Python
1,292
star
90

CrypTen

A framework for Privacy Preserving Machine Learning
Python
1,283
star
91

denoiser

Real Time Speech Enhancement in the Waveform Domain (Interspeech 2020)We provide a PyTorch implementation of the paper Real Time Speech Enhancement in the Waveform Domain. In which, we present a causal speech enhancement model working on the raw waveform that runs in real-time on a laptop CPU. The proposed model is based on an encoder-decoder architecture with skip-connections. It is optimized on both time and frequency domains, using multiple loss functions. Empirical evidence shows that it is capable of removing various kinds of background noise including stationary and non-stationary noises, as well as room reverb. Additionally, we suggest a set of data augmentation techniques applied directly on the raw waveform which further improve model performance and its generalization abilities.
Python
1,272
star
92

DeepSDF

Learning Continuous Signed Distance Functions for Shape Representation
Python
1,191
star
93

TimeSformer

The official pytorch implementation of our paper "Is Space-Time Attention All You Need for Video Understanding?"
Python
1,172
star
94

House3D

a Realistic and Rich 3D Environment
C++
1,167
star
95

MaskFormer

Per-Pixel Classification is Not All You Need for Semantic Segmentation (NeurIPS 2021, spotlight)
Python
1,149
star
96

LAMA

LAnguage Model Analysis
Python
1,104
star
97

fastMRI

A large-scale dataset of both raw MRI measurements and clinical MRI images.
Python
1,098
star
98

meshrcnn

code for Mesh R-CNN, ICCV 2019
Python
1,083
star
99

mixup-cifar10

mixup: Beyond Empirical Risk Minimization
Python
1,073
star
100

DomainBed

DomainBed is a suite to test domain generalization algorithms
Python
1,071
star