Skip to content

Commit 7d92630

Browse files
authored
Update installation instructions in documentation (#2325)
Signed-off-by: Sun, Xuehao <[email protected]>
1 parent 84f727b commit 7d92630

File tree

2 files changed

+36
-21
lines changed

2 files changed

+36
-21
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Intel® Neural Compressor
44
===========================
55
<h3> An open-source Python library supporting popular model compression techniques on all mainstream deep learning frameworks (TensorFlow, PyTorch, and ONNX Runtime)</h3>
66

7-
[![python](https://img.shields.io/badge/python-3.8%2B-blue)](https://github.com/intel/neural-compressor)
7+
[![python](https://img.shields.io/badge/python-3.10%2B-blue)](https://github.com/intel/neural-compressor)
88
[![version](https://img.shields.io/badge/release-3.6-green)](https://github.com/intel/neural-compressor/releases)
99
[![license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/intel/neural-compressor/blob/master/LICENSE)
1010
[![coverage](https://img.shields.io/badge/coverage-85%25-green)](https://github.com/intel/neural-compressor)

docs/source/installation_guide.md

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can install Neural Compressor using one of three options: Install single com
2222

2323
The following prerequisites and requirements must be satisfied for a successful installation:
2424

25-
- Python version: 3.8 or 3.9 or 3.10 or 3.11
25+
- Python version: 3.10 or 3.11 or 3.12
2626

2727
> Notes:
2828
> - If you get some build issues, please check [frequently asked questions](faq.md) at first.
@@ -73,14 +73,28 @@ pip install neural-compressor-tf
7373

7474
### Install from Source
7575

76-
```Shell
77-
git clone https://github.com/intel/neural-compressor.git
78-
cd neural-compressor
79-
pip install -r requirements.txt
80-
python setup.py install
81-
[optional] pip install -r requirements_pt.txt # for PyTorch framework extension API
82-
[optional] pip install -r requirements_tf.txt # for TensorFlow framework extension API
83-
```
76+
```Shell
77+
git clone https://github.com/intel/neural-compressor.git
78+
cd neural-compressor
79+
pip install -r requirements.txt
80+
```
81+
82+
```Shell
83+
# PyTorch framework extension API + PyTorch dependency
84+
INC_PT_ONLY=1 pip install .
85+
```
86+
87+
```Shell
88+
# TensorFlow framework extension API + TensorFlow dependency
89+
INC_TF_ONLY=1 pip install .
90+
```
91+
92+
```Shell
93+
# Full Installation
94+
pip install .
95+
[optional] pip install -r requirements_pt.txt # for PyTorch framework extension API
96+
[optional] pip install -r requirements_tf.txt # for TensorFlow framework extension API
97+
```
8498

8599
### Install from AI Kit
86100

@@ -97,27 +111,28 @@ The AI Kit is distributed through many common channels, including from Intel's w
97111
### Validated Hardware Environment
98112

99113
#### Intel® Neural Compressor supports HPUs based on heterogeneous architecture with two compute engines (MME and TPC):
100-
* Intel Gaudi Al Accelerators (Gaudi2)
114+
* Intel Gaudi Al Accelerators (Gaudi2, Gaudi3)
101115

102116
#### Intel® Neural Compressor supports CPUs based on [Intel 64 architecture or compatible processors](https://en.wikipedia.org/wiki/X86-64):
103117

104-
* Intel Xeon Scalable processor (Skylake, Cascade Lake, Cooper Lake, Ice Lake, and Sapphire Rapids)
118+
* Intel Xeon Scalable processor (Sapphire Rapids, Emerald Rapids, Granite Rapids)
105119
* Intel Xeon CPU Max Series (Sapphire Rapids HBM)
106-
* Intel Core Ultra Processors (Meteor Lake)
120+
* Intel Core Ultra Processors (Meteor Lake, Lunar Lake)
107121

108122
#### Intel® Neural Compressor supports GPUs built on Intel's Xe architecture:
109123

110124
* Intel Data Center GPU Flex Series (Arctic Sound-M)
111125
* Intel Data Center GPU Max Series (Ponte Vecchio)
126+
* Intel® Arc™ B-Series Graphics (Battlemage)
112127

113128
#### Intel® Neural Compressor quantized ONNX models support multiple hardware vendors through ONNX Runtime:
114129

115130
* Intel CPU, AMD/ARM CPU, and NVidia GPU. Please refer to the validated model [list](./validated_model_list.md#validated-onnx-qdq-int8-models-on-multiple-hardware-through-onnx-runtime).
116131

117132
### Validated Software Environment
118133

119-
* OS version: CentOS 8.4, Ubuntu 22.04, MacOS Ventura 13.5, Windows 11
120-
* Python version: 3.8, 3.9, 3.10, 3.11
134+
* OS version: CentOS 8.4, Ubuntu 24.04, MacOS Ventura 13.5, Windows 11
135+
* Python version: 3.10, 3.11, 3.12
121136

122137
<table class="docutils">
123138
<thead>
@@ -142,13 +157,13 @@ The AI Kit is distributed through many common channels, including from Intel's w
142157
<a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v2.14.0.1>2.14.0.1</a><br>
143158
<a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v2.13.0.0>2.13.0.0</a><br></td>
144159
<td class="tg-7zrl">
145-
<a href=https://github.com/pytorch/pytorch/tree/v2.3.0>2.3.0</a><br>
146-
<a href=https://github.com/pytorch/pytorch/tree/v2.2.2>2.2.2</a><br>
147-
<a href=https://github.com/pytorch/pytorch/tree/v2.1.1>2.1.1</a><br></td>
160+
<a href=https://github.com/pytorch/pytorch/tree/v2.8.0>2.8.0</a><br>
161+
<a href=https://github.com/pytorch/pytorch/tree/v2.7.1>2.7.1</a><br>
162+
<a href=https://github.com/pytorch/pytorch/tree/v2.6.0>2.6.0</a><br></td>
148163
<td class="tg-7zrl">
149-
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.3.0%2Bcpu>2.3.0</a><br>
150-
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.2.0%2Bcpu>2.2.0</a><br>
151-
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.1.100%2Bcpu>2.1.100</a><br></td>
164+
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.8.0%2Bcpu>2.8.0</a><br>
165+
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.7.0%2Bcpu>2.7.0</a><br>
166+
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.6.0%2Bcpu>2.6.0</a><br></td>
152167
<td class="tg-7zrl">
153168
<a href=https://github.com/microsoft/onnxruntime/tree/v1.18.0>1.18.0</a><br>
154169
<a href=https://github.com/microsoft/onnxruntime/tree/v1.17.3>1.17.3</a><br>

0 commit comments

Comments
 (0)