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 network on efficient hardware.
Specifically, this project applies constrained quantization and pruning schemes on a neural network.
Currently, this project only supports hardware friendly post training quantization (HPTQ) with Tensorflow 2 [1].
The MCT project is developed by researchers and engineers working at Sony Semiconductors Israel.
For more information, please visit our project website.
Table of Contents
Getting Started
This section provides a quick starting guide. We begin with installtion via source code or pip server. Then, we provide a short usage example.
Installation
See the MCT install guide for the pip package, and build from source.
From Source
git clone https://github.com/sony/model_optimization.git
python setup.py install
From PyPi - latest stable release
pip install model-compression-toolkit
A nightly package is also available (unstable):
pip install mct-nightly
Usage Example
An example of how to use the post training quantization, using Keras, is shown in the following code snapshot.
import model_compression_toolkit as mct
# Set the batch size of the images at each calibration iteration.
batch_size = 50
# Create a representative data generator, which returns a list of images.
# Load a folder of images.
folder = '/path/to/images/folder'
# The images can be preprocessed using a list of preprocessing functions.
def normalization(x):
return (x - 127.5) / 127.5
# Create a FolderImageLoader instance which loads the images, preprocess them and enables you to sample batches of them.
image_data_loader = mct.FolderImageLoader(folder,
preprocessing=[normalization],
batch_size=batch_size)
# Create a Callable representative dataset for calibration purposes.
# The function should be called without any arguments, and should return a list numpy arrays (array for each model's input).
# For example: if the model has two input tensors - one with input shape of 32X32X3 and the second with input
# shape of 224X224X3, and we calibrate the model using batches of 20 images,
# calling representative_data_gen() should return a list
# of two numpy.ndarray objects where the arrays' shapes are [(20, 32, 32, 3), (20, 224, 224, 3)].
def representative_data_gen() -> list:
return [image_data_loader.sample()]
# Create a model and quantize it using the representative_data_gen as the calibration images.
# Set the number of calibration iterations to 10.
quantized_model, quantization_info = mct.keras_post_training_quantization(model,
representative_data_gen,
n_iter=10)
For more examples please see the tutorials' directory.
Supported Features
Quantization:
* Post Training Quantization
* Gradient based post training (Experimental)
Tensorboard Visualization (Experimental):
* CS Analyizer: compare a model compressed with the orignal model to analyze large accuracy drops.
* Activation statisicis and errors
Note that currently we only have full support for Keras layers. Using the TensorFlow native layers may lead to unexpected behavior. This limitation will be removed in future releases.
MCT is tested with Tensorflow Version 2.5.
Tutorials and Results
As part of the MCT library, we have a set of example networks on image classification. These networks can be used as examples when using the package.
- Image Classification Example with MobileNet V1 on ImageNet dataset
| Network Name | Float Accuracy | 8Bit Accuracy | Comments |
|---|---|---|---|
| MobileNetV1 [2] | 70.558 | 70.418 |
For more results please see [1]
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
Refernce
[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.
2 maintainers
Metadata
2 maintainers
Release files for mct-nightly 1.1.0.20122021.post2442
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mct-nightly-1.1.0.20122021.post2442.tar.gz | 122.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mct_nightly-1.1.0.20122021.post2442-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 358.0 kB
Release files / mct-nightly-1.1.0.20122021.post2442.tar.gz
| Download URL | mct-nightly-1.1.0.20122021.post2442.tar.gz |
|---|---|
| Size | 122.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
758f420a80247962da18bfd3672af26e4fd1dfcd7bbe50ba8275a7de19b89e11
|
|
BLAKE2b-256 checksum How to use checksums |
364ee72475545d65b02319be3ddadb1a5dc13707ef405a9de2e5df8e4f0f4528
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
|
Release files / mct_nightly-1.1.0.20122021.post2442-py3-none-any.whl
| Download URL | mct_nightly-1.1.0.20122021.post2442-py3-none-any.whl |
|---|---|
| Size | 235.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c8cc4d3d9a4b181a92b709c5a1bf61495f76db2699abb38e530eb6f34392ba0f
|
|
BLAKE2b-256 checksum How to use checksums |
253ca2cfbbd8d82a8e25fbb82665e1169ee0de52b80f269d6c60e8440282e683
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
|
