-
1.1. Prerequisites
1.2. Install from Binary
1.3. Install from Source
1.4. Install from AI Kit
You can install Neural Compressor using one of three options: Install single component from binary or source, or get the Intel-optimized framework together with the library by installing the Intel® oneAPI AI Analytics Toolkit.
The following prerequisites and requirements must be satisfied for a successful installation:
- Python version: 3.8 or 3.9 or 3.10 or 3.11
Notes:
- If you get some build issues, please check frequently asked questions at first.
-
Install from Pypi
# install stable basic version from pypi pip install neural-compressor
# [Experimental] install stable basic + PyTorch framework extension API from pypi pip install neural-compressor[pt]
# [Experimental] install stable basic + TensorFlow framework extension API from pypi pip install neural-compressor[tf]
-
Install from test Pypi
# install nightly version git clone https://github.com/intel/neural-compressor.git cd neural-compressor pip install -r requirements.txt # install nightly basic version from pypi pip install -i https://test.pypi.org/simple/ neural-compressor
git clone https://github.com/intel/neural-compressor.git
cd neural-compressor
pip install -r requirements.txt
python setup.py install
[optional] pip install requirements_pt.txt # for PyTorch framework extension API
[optional] pip install requirements_tf.txt # for TensorFlow framework extension API
The Intel® Neural Compressor library is released as part of the Intel® oneAPI AI Analytics Toolkit (AI Kit). The AI Kit provides a consolidated package of Intel's latest deep learning and machine optimizations all in one place for ease of development. Along with Neural Compressor, the AI Kit includes Intel-optimized versions of deep learning frameworks (such as TensorFlow and PyTorch) and high-performing Python libraries to streamline end-to-end data science and AI workflows on Intel architectures.
The AI Kit is distributed through many common channels, including from Intel's website, YUM, APT, Anaconda, and more. Select and download the AI Kit distribution package that's best suited for you and follow the Get Started Guide for post-installation instructions.
Download | Guide |
---|---|
Download AI Kit | AI Kit Get Started Guide |
Intel® Neural Compressor supports CPUs based on Intel 64 architecture or compatible processors:
- Intel Xeon Scalable processor (formerly Skylake, Cascade Lake, Cooper Lake, Ice Lake, and Sapphire Rapids)
- Intel Xeon CPU Max Series (formerly Sapphire Rapids HBM)
- Intel Data Center GPU Flex Series (formerly Arctic Sound-M)
- Intel Data Center GPU Max Series (formerly Ponte Vecchio)
Intel® Neural Compressor quantized ONNX models support multiple hardware vendors through ONNX Runtime:
- Intel CPU, AMD/ARM CPU, and NVidia GPU. Please refer to the validated model list.
- OS version: CentOS 8.4, Ubuntu 22.04, MacOS Ventura 13.5, Windows 11
- Python version: 3.8, 3.9, 3.10, 3.11
Framework | TensorFlow | Intel® Extension for TensorFlow* |
PyTorch | Intel® Extension for PyTorch* |
ONNX Runtime |
---|---|---|---|---|---|
Version |
2.16.1 2.15.0 2.14.1 |
2.15.0.0 2.14.0.1 2.13.0.0 |
2.3.0 2.2.2 2.1.1 |
2.3.0 2.2.0 2.1.100 |
1.18.0 1.17.3 1.16.3 |