Neural Network Compression Framework (NNCF)

This repository contains a PyTorch*-based framework and samples for neural networks compression.

The framework is organized as a Python* package that can be built and used in a standalone mode. The framework architecture is unified to make it easy to add different compression methods.

The samples demonstrate the usage of compression algorithms for three different use cases on public models and datasets: Image Classification, Object Detection and Semantic Segmentation. Compression results achievable with the NNCF-powered samples can be found in a table at the end of this document.

Key Features

Support of various compression algorithms, applied during a model fine-tuning process to achieve best compression parameters and accuracy:
Automatic, configurable model graph transformation to obtain the compressed model. The source model is wrapped by the custom class and additional compression-specific layers are inserted in the graph.
Common interface for compression methods
GPU-accelerated layers for faster compressed model fine-tuning
Distributed training support
Configuration file examples for each supported compression algorithm.
Git patches for prominent third-party repositories (mmdetection, huggingface-transformers) demonstrating the process of integrating NNCF into custom training pipelines
Exporting compressed models to ONNX* checkpoints ready for usage with OpenVINO™ toolkit.

Usage

The NNCF is organized as a regular Python package that can be imported in your target training pipeline script. The basic workflow is loading a JSON configuration script containing NNCF-specific parameters determining the compression to be applied to your model, and then passing your model along with the configuration script to the nncf.create_compressed_model function. This function returns a wrapped model ready for compression fine-tuning, and handle to the object allowing you to control the compression during the training process:

import torch
import nncf  # Important - should be imported directly after torch
from nncf import create_compressed_model, NNCFConfig, register_default_init_args

# Instantiate your uncompressed model
from torchvision.models.resnet import resnet50
model = resnet50()

# Load a configuration file to specify compression
nncf_config = NNCFConfig.from_json("resnet50_int8.json")

# Provide data loaders for compression algorithm initialization, if necessary
nncf_config = register_default_init_args(nncf_config, train_loader, loss_criterion)

# Apply the specified compression algorithms to the model
comp_ctrl, compressed_model = create_compressed_model(model, nncf_config)

# Now use compressed_model as a usual torch.nn.Module to fine-tune compression parameters along with the model weights

# ... the rest of the usual PyTorch-powered training pipeline

# Export to ONNX or .pth when done fine-tuning
comp_ctrl.export_model("compressed_model.onnx")
torch.save(compressed_model.state_dict(), "compressed_model.pth")

For a more detailed description of NNCF usage in your training code, see Usage.md. For in-depth examples of NNCF integration, browse the sample scripts code, or the example patches to third-party repositories.

For more details about the framework architecture, refer to the NNCFArchitecture.md.

Model Compression Samples

For a quicker start with NNCF-powered compression, you can also try the sample scripts, each of which provides a basic training pipeline for classification, semantic segmentation and object detection neural network training correspondingly.

To run the samples please refer to the corresponding tutorials:

Third-party repository integration

NNCF may be straightforwardly integrated into training/evaluation pipelines of third-party repositories. See third_party_integration for examples of code modifications (Git patches and base commit IDs are provided) that are necessary to integrate NNCF into select repositories.

System requirements

Ubuntu* 18.04 or later (64-bit)
Python* 3.7 or later
NVidia CUDA* Toolkit 10.2
PyTorch* 1.7 or later.

Installation

We suggest to install or use the package in the Python virtual environment.

As a package built from a checked-out repository:

Install the following system dependencies:

sudo apt-get install python3-dev

Install the package and its dependencies by running the following in the repository root directory:

For CPU & GPU-powered execution: python setup.py install
For CPU-only installation python setup.py install --cpu-only

NB: For launching example scripts in this repository, we recommend replacing the install option above with develop and setting the PYTHONPATH variable to the root of the checked-out repository.

As a PyPI package:

NNCF can be installed as a regular PyPI package via pip:

sudo apt install python3-dev
pip install nncf

As a Docker image

Use one of the Dockerfiles in the docker directory to build an image with an environment already set up and ready for running NNCF sample scripts.

NOTE: If you want to use sample training scripts provided in the NNCF repository under examples, you should install the corresponding Python package dependencies:

pip install examples/requirements.txt

Contributing

Refer to the CONTRIBUTING.md file for guidelines on contributions to the NNCF repository.

NNCF Compressed Model Zoo

Results achieved using sample scripts and NNCF configuration files provided with this repository. See README.md files for sample scripts for links to exact configuration files and final PyTorch checkpoints.

Quick jump to sample type:

Classification

Object detection

Semantic segmentation

Natural language processing (3rd-party training pipelines)

Object detection (3rd-party training pipelines)

Instance Segmentation (3rd-party training pipelines)

Classification

Model	Compression algorithm	Dataset	PyTorch FP32 baseline	PyTorch compressed accuracy
ResNet-50	INT8	ImageNet	76.04	75.97
ResNet-50	Mixed, 44.8% INT8 / 55.2% INT4	ImageNet	76.04	76.31
ResNet-50	INT8 + Sparsity 61% (RB)	ImageNet	76.04	75.21
ResNet-50	INT8 + Sparsity 50% (RB)	ImageNet	76.04	75.73
ResNet-50	Filter pruning, 40%, geometric median criterion	ImageNet	76.04	75.57
Inception V3	INT8	ImageNet	77.31	76.97
Inception V3	INT8 + Sparsity 61% (RB)	ImageNet	77.31	76.95
MobileNet V2	INT8	ImageNet	71.75	71.32
MobileNet V2	Mixed, 46.6% INT8 / 53.4% INT4	ImageNet	71.75	71.03
MobileNet V2	INT8 + Sparsity 52% (RB)	ImageNet	71.75	70.94
SqueezeNet V1.1	INT8	ImageNet	58.24	58.04
SqueezeNet V1.1	Mixed, 54.7% INT8 / 45.3% INT4	ImageNet	58.24	58.77
ResNet-18	XNOR (weights), scale/threshold (activations)	ImageNet	69.68	61.57
ResNet-18	DoReFa (weights), scale/threshold (activations)	ImageNet	69.68	61.65
ResNet-18	Filter pruning, 40%, magnitude criterion	ImageNet	69.68	69.19
ResNet-18	Filter pruning, 40%, geometric median criterion	ImageNet	69.68	69.29
ResNet-34	Filter pruning, 40%, geometric median criterion	ImageNet	73.26	72.72
GoogLeNet	Filter pruning, 40%, geometric median criterion	ImageNet	69.72	68.89

Object detection

Model	Compression algorithm	Dataset	PyTorch FP32 baseline	PyTorch compressed accuracy
SSD300-MobileNet	INT8 + Sparsity 70% (Magnitude)	VOC12+07 train, VOC12 eval	86.02	85.82
SSD300-BN	INT8	VOC12+07 train, VOC12 eval	96.53	96.5
SSD300-BN	INT8 + Sparsity 70% (Magnitude)	VOC12+07 train, VOC12 eval	96.53	95.4
SSD300-BN	Filter pruning, 40%, geometric median criterion	VOC12+07 train, VOC12 eval	96.53	91.98
SSD512-BN	INT8	VOC12+07 train, VOC12 eval	97.59	97.37
SSD512-BN	INT8 + Sparsity 70% (Magnitude)	VOC12+07 train, VOC12 eval	97.59	96.66

Semantic segmentation

Model	Compression algorithm	Dataset	PyTorch FP32 baseline	PyTorch compressed accuracy
UNet	INT8	CamVid	71.95	71.66
UNet	INT8 + Sparsity 60% (Magnitude)	CamVid	71.95	71.72
ICNet	INT8	CamVid	67.89	67.78
ICNet	INT8 + Sparsity 60% (Magnitude)	CamVid	67.89	67.16
UNet	INT8	Mapillary	56.23	56.1
UNet	INT8 + Sparsity 60% (Magnitude)	Mapillary	56.23	56.01
UNet	Filter pruning, 25%, geometric median criterion	Mapillary	56.23	55.62

NLP

Model	Compression algorithm	Dataset	PyTorch FP32 baseline	PyTorch compressed accuracy
BERT-base-chinese	INT8	XNLI	77.68	77.22
BERT-large (Whole Word Masking)	INT8	SQuAD v1.1	93.21 (F1)	92.68 (F1)
RoBERTa-large	INT8	MNLI	90.6 (matched)	89.25 (matched)
DistilBERT-base	INT8	SST-2	91.1	90.3
MobileBERT	INT8	SQuAD v1.1	89.98 (F1)	89.4 (F1)
GPT-2	INT8	WikiText-2 (raw)	19.73 (perplexity)	20.9 (perplexity)

Object detection (MMDetection)

Model	Compression algorithm	Dataset	PyTorch FP32 baseline	PyTorch compressed accuracy
RetinaNet-ResNet50-FPN	INT8	COCO2017	35.6 (avg bbox mAP)	35.3 (avg bbox mAP)
RetinaNet-ResNet50-FPN	INT8 + Sparsity 50%	COCO2017	35.6 (avg bbox mAP)	34.7 (avg bbox mAP)
RetinaNet-ResNeXt101-64x4d-FPN	INT8	COCO2017	39.6 (avg bbox mAP)	39.1 (avg bbox mAP)

Instance Segmentation (MMDetection)

Model	Compression algorithm	Dataset	PyTorch FP32 baseline	PyTorch compressed accuracy
Mask-RCNN-ResNet50-FPN	INT8	COCO2017	40.8 (avg bbox mAP), 37.0 (avg segm mAP)	40.6 (avg bbox mAP), 36.5 (avg segm mAP)

Citing

@article{kozlov2020neural,
    title =   {Neural network compression framework for fast model inference},
    author =  {Kozlov, Alexander and Lazarevich, Ivan and Shamporov, Vasily and Lyalyushkin, Nikolay and Gorbachev, Yury},
    journal = {arXiv preprint arXiv:2002.08679},
    year =    {2020}
}

Legal Information

[*] Other names and brands may be claimed as the property of others.

lzrvch/nncf

Neural Network Compression Framework (NNCF)

Key Features

Usage

Model Compression Samples

Third-party repository integration

System requirements

Installation

As a package built from a checked-out repository:

As a PyPI package:

As a Docker image

Contributing

NNCF Compressed Model Zoo

Classification

Object detection

Semantic segmentation

NLP

Object detection (MMDetection)

Instance Segmentation (MMDetection)

Citing

Legal Information