Skip to main content

Model Compression Toolkit (MCT)

Model Compression Toolkit (MCT) is an open-source project for neural network model optimization under efficient, constrained hardware.

This project provides researchers, developers, and engineers tools for optimizing and deploying state-of-the-art neural networks on efficient hardware.

Specifically, this project aims to apply quantization to compress neural networks.

MCT is developed by researchers and engineers working at Sony Semiconductor Israel.

Table of Contents

Supported Features

MCT supports different quantization methods:

Quantization Method Complexity Computational Cost
PTQ Low Low (order of minutes)
GPTQ Mild (parameters fine-tuning using gradients) Mild (order of 2-3 hours)
QAT High High (order of 12-36 hours)

In addition, MCT supports different quantization schemes for quantizing weights and activations:

  • Power-Of-Two (hardware-friendly quantization [1])
  • Symmetric
  • Uniform

Main features:

  • Graph optimizations: Transforming the model to an equivalent (yet, more efficient) model (for example, batch-normalization layer folding to its preceding linear layer).
  • Quantization parameter search: Different methods can be used to minimize the expected added quantization-noise during thresholds search (by default, we use Mean-Square-Error, but other metrics can be used such as No-Clipping, Mean-Average-Error, and more).
  • Advanced quantization algorithms: To prevent a performance degradation some algorithms are applied such as:
    • Shift negative correction: Symmetric activation quantization can hurt the model's performance when some layers output both negative and positive activations, but their range is asymmetric. For more details please visit [1].
    • Outliers filtering: Computing z-score for activation statistics to detect and remove outliers.
  • Clustering: Using non-uniform quantization grid to quantize the weights and activations to match their distributions.*
  • Mixed-precision search: Assigning quantization bit-width per layer (for weights/activations), based on the layer's sensitivity to different bit-widths.
  • Visualization: You can use TensorBoard to observe useful information for troubleshooting the quantized model's performance (for example, the model in different phases of the quantization, collected statistics, similarity between layers of the float and quantized model and bit-width configuration for mixed-precision quantization). For more details, please read the visualization documentation.
  • Target Platform Capabilities: The Target Platform Capabilities (TPC) describes the target platform (an edge device with dedicated hardware). For more details, please read the TPC README.

Experimental features

Some features are experimental and subject to future changes.

For more details, we highly recommend visiting our project website where experimental features are mentioned as experimental.

Getting Started

This section provides a quick starting guide. We begin with installation via source code or pip server. Then, we provide a short usage example.

Setting up work environment

Clone the repository and install the required packages (via requirements).

git clone https://github.com/sony/model_optimization.git
cd model_optimization
pip install -r requirements.txt

Installation

See the MCT install guide for the pip package.

From PyPi - latest stable release

pip install model-compression-toolkit

A nightly package is also available (unstable):

pip install mct-nightly

Requirements

To run MCT, one of the supported frameworks, Tensorflow/Pytorch, needs to be installed.

For use with Tensorflow please install the packages: tensorflow, tensorflow-model-optimization

For use with PyTorch please install the packages: torch

Also, a requirements file can be used to set up your environment.

Supported Python Versions

Currently, MCT is being tested on various Python versions:

Python Version
Run Tests - Python 3.10
Run Tests - Python 3.9
Run Tests - Python 3.8
Run Tests - Python 3.7

Supported NN-Frameworks Versions

Currently, MCT supports compressing models of TensorFlow and PyTorch, and is tested on various versions:

TensorFlow Version PyTorch Version
tests tests
tests tests
tests tests

Usage Example

For an example of how to use the post-training quantization, using Keras, please use this link.

For an example using PyTorch, please use this link.

For more examples please see the tutorials' directory.

Results

Keras

Graph of MobileNetV2 accuracy on ImageNet vs average bit-width of weights, using single-precision quantization, mixed-precision quantization, and mixed-precision quantization with GPTQ.

For more results, please see [1]

Pytorch

We quantized classification networks from the torchvision library. In the following table we present the ImageNet validation results for these models:

Network Name Float Accuracy 8Bit Accuracy
MobileNet V2 [3] 71.886 71.444
ResNet-18 [3] 69.86 69.63
SqueezeNet 1.1 [3] 58.128 57.678

For more results, please refer to quick start.

Contributions

MCT aims at keeping a more up-to-date fork and welcomes contributions from anyone.

*You will find more information about contributions in the Contribution guide.

License

Apache License 2.0.

References

[1] Habi, H.V., Peretz, R., Cohen, E., Dikstein, L., Dror, O., Diamant, I., Jennings, R.H. and Netzer, A., 2021. HPTQ: Hardware-Friendly Post Training Quantization. arXiv preprint.

[2] MobilNet from Keras applications.

[3] TORCHVISION.MODELS

Metadata

Release files for mct-nightly 1.8.0.20230615.post402

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mct-nightly 1.8.0.20230615.post402
File Size Uploaded
mct-nightly-1.8.0.20230615.post402.tar.gz 351.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mct-nightly 1.8.0.20230615.post402
File Interpreter ABI Platform
mct_nightly-1.8.0.20230615.post402-py3-none-any.whl Python 3 none any Details

Total release size: 1.1 MB

Release files / mct-nightly-1.8.0.20230615.post402.tar.gz

Download URL mct-nightly-1.8.0.20230615.post402.tar.gz
Size 351.0 kB
Tags Source
SHA-256 checksum
How to use checksums
d4162c5d665c062a455624e11da75efab947dd30cba9224e5e713078382337af
BLAKE2b-256 checksum
How to use checksums
7ce3aa41fa5956ba286973b13714f45a5d20fce80965f325443541909bea0128
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.17

Release files / mct_nightly-1.8.0.20230615.post402-py3-none-any.whl

Download URL mct_nightly-1.8.0.20230615.post402-py3-none-any.whl
Size 716.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d765298d3b2f01457afff65e0fdb11931e5304e138691d7b2bbda7cb60cd65a1
BLAKE2b-256 checksum
How to use checksums
1f8d43aa4be621628074a533751703bd05f29731a1527c46785600667ba284fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.17

Release history Release notifications | RSS feed

This release

1.8.0.20230615.post402 This release

2 release files

0.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page