Skip to main content

Neural Networks Compression Framework

Project description

GitHub Release Website Apache License Version 2.0 PyPI Downloads

Neural Network Compression Framework (NNCF)

Neural Network Compression Framework (NNCF) provides a suite of post-training and training-time algorithms for optimizing inference of neural networks in OpenVINO™ with a minimal accuracy drop.

NNCF is designed to work with models from PyTorch, TorchFX, ONNX and OpenVINO™.

NNCF provides samples that demonstrate the usage of compression algorithms for different use cases and models. See compression results achievable with the NNCF-powered samples on the NNCF Model Zoo page.

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 algorithms for both PyTorch deep learning frameworks.

For more information about NNCF, see:

Table of contents

Key Features

Post-Training Compression Algorithms

Compression algorithm OpenVINO PyTorch TorchFX ONNX
Post-Training Quantization Supported Supported Experimental Supported
Weights Compression Supported Supported Experimental Supported
Activation Sparsity Not supported Experimental Not supported Not supported

Training-Time Compression Algorithms

Compression algorithm PyTorch
Quantization Aware Training Supported
Weight-Only Quantization Aware Training with LoRA and NLS Supported
Pruning Supported
  • Automatic, configurable model graph transformation to obtain the compressed model.
  • Common interface for compression methods.
  • GPU-accelerated layers for faster compressed model fine-tuning.
  • Distributed training support.
  • Git patch for prominent third-party repository (huggingface-transformers) demonstrating the process of integrating NNCF into custom training pipelines.
  • Exporting PyTorch compressed models to ONNX* checkpoints compressed models to SavedModel or Frozen Graph format, ready to use with OpenVINO™ toolkit.

Installation Guide

For detailed installation instructions, refer to the Installation guide.

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

pip install nncf

NNCF is also available via conda:

conda install -c conda-forge nncf

System requirements of NNCF correspond to the used backend. System requirements for each backend and the matrix of corresponding versions can be found in installation.md.

Third-party Repository Integration

NNCF may be easily integrated into training/evaluation pipelines of third-party repositories.

Used by

  • HuggingFace Optimum Intel

    NNCF is used as a compression backend within the renowned transformers repository in HuggingFace Optimum Intel. For instance, the command below exports the Llama-3.2-3B-Instruct model to OpenVINO format with INT4-quantized weights:

    optimum-cli export openvino -m meta-llama/Llama-3.2-3B-Instruct --weight-format int4 ./Llama-3.2-3B-Instruct-int4
    
  • Ultralytics

    NNCF is integrated into the Intel OpenVINO export pipeline, enabling quantization for the exported models.

  • ExecuTorch

    NNCF is used as primary quantization framework for the ExecuTorch OpenVINO integration.

  • torch.compile

    NNCF is used as primary quantization framework for the torch.compile OpenVINO integration.

  • OpenVINO Training Extensions

    NNCF is integrated into OpenVINO Training Extensions as a model optimization backend. You can train, optimize, and export new models based on available model templates as well as run the exported models with OpenVINO.

  • Microsoft Olive

    NNCF is used to quantize OpenVINO IR and ONNX models for the OpenVINO integration.

NNCF Compressed Model Zoo

List of models and compression results for them can be found at our NNCF Model Zoo page.

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}
}

Telemetry

NNCF as part of the OpenVINO™ toolkit collects anonymous usage data for the purpose of improving OpenVINO™ tools. You can opt-out at any time by running the following command in the Python environment where you have NNCF installed:

opt_in_out --opt_out

More information available on OpenVINO telemetry.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nncf-3.2.0.tar.gz (558.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nncf-3.2.0-py3-none-any.whl (801.1 kB view details)

Uploaded Python 3

File details

Details for the file nncf-3.2.0.tar.gz.

File metadata

  • Download URL: nncf-3.2.0.tar.gz
  • Upload date:
  • Size: 558.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for nncf-3.2.0.tar.gz
Algorithm Hash digest
SHA256 5dd42d80d0dd8faa316cfb7773defc70f76d9be6e9829005904580391660f4db
MD5 9069552d49a89ecbf3d2862391b9d437
BLAKE2b-256 af8a17121c8cfa07afb56461556501919d69bf4bf76ed1c34c4f90663414a923

See more details on using hashes here.

File details

Details for the file nncf-3.2.0-py3-none-any.whl.

File metadata

  • Download URL: nncf-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 801.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for nncf-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53a52cb2621ed1f786848046a1d9b7fe7ebc31bc927eeeb0ef599ab5fcc98632
MD5 f950d1aa02cbe7f2e2aa43761600051d
BLAKE2b-256 a9ff7dc1fa2695317bc084886d166e4e5865537dc7fa5891cf069d0ace8e6a80

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page