Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update v2.6 release readme #1871

Merged
merged 4 commits into from
Jun 14, 2024
Merged

update v2.6 release readme #1871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9d84888
update v2.6 release readme
chensuyue Jun 14, 2024
4bd6e4c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 14, 2024
26616d9
remove onnx 3x binary
chensuyue Jun 14, 2024
dc7acfe
Merge branch 'suyue/2.6_release' of https://github.com/intel/neural-c…
chensuyue Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Intel® Neural Compressor
<h3> An open-source Python library supporting popular model compression techniques on all mainstream deep learning frameworks (TensorFlow, PyTorch, ONNX Runtime, and MXNet)</h3>

[![python](https://img.shields.io/badge/python-3.8%2B-blue)](https://github.com/intel/neural-compressor)
[![version](https://img.shields.io/badge/release-2.5-green)](https://github.com/intel/neural-compressor/releases)
[![version](https://img.shields.io/badge/release-2.6-green)](https://github.com/intel/neural-compressor/releases)
[![license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/intel/neural-compressor/blob/master/LICENSE)
[![coverage](https://img.shields.io/badge/coverage-85%25-green)](https://github.com/intel/neural-compressor)
[![Downloads](https://static.pepy.tech/personalized-badge/neural-compressor?period=total&units=international_system&left_color=grey&right_color=green&left_text=downloads)](https://pepy.tech/project/neural-compressor)
Expand Down
48 changes: 0 additions & 48 deletions conda_meta/basic/meta.yaml
View file
Open in desktop

This file was deleted.

43 changes: 0 additions & 43 deletions conda_meta/neural_insights/meta.yaml
View file
Open in desktop

This file was deleted.

44 changes: 0 additions & 44 deletions conda_meta/neural_solution/meta.yaml
View file
Open in desktop

This file was deleted.

54 changes: 21 additions & 33 deletions docs/source/installation_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,27 +52,15 @@ The following prerequisites and requirements must be satisfied for a successful
pip install -i https://test.pypi.org/simple/ neural-compressor
```

- Install from Conda
```Shell
# install on Linux OS
conda install opencv-python-headless -c fastai
conda install neural-compressor -c conda-forge -c intel
```
```Shell
# install on Windows OS
conda install pycocotools -c esri
conda install opencv-python-headless -c fastai
conda install neural-compressor -c conda-forge -c intel
```

### Install from Source

```Shell
git clone https://github.com/intel/neural-compressor.git
cd neural-compressor
pip install -r requirements.txt
# build with basic functionality
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
```

### Install from AI Kit
Expand Down Expand Up @@ -112,7 +100,6 @@ The AI Kit is distributed through many common channels, including from Intel's w
<tr style="vertical-align: middle; text-align: center;">
<th>Framework</th>
<th>TensorFlow</th>
<th>Intel<br>TensorFlow</th>
<th>Intel®<br>Extension for<br>TensorFlow*</th>
<th>PyTorch</th>
<th>Intel®<br>Extension for<br>PyTorch*</th>
Expand All @@ -122,25 +109,26 @@ The AI Kit is distributed through many common channels, including from Intel's w
<tbody>
<tr align="center">
<th>Version</th>
<td class="tg-7zrl"> <a href=https://github.com/tensorflow/tensorflow/tree/v2.15.0>2.15.0</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.14.1>2.14.1</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.13.1>2.13.1</a><br></td>
<td class="tg-7zrl"> <a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.14.0>2.14.0</a><br>
<a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.13.0>2.13.0</a><br></td>
<td class="tg-7zrl"> <a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v2.14.0.1>2.14.0.1</a><br>
<td class="tg-7zrl">
<a href=https://github.com/tensorflow/tensorflow/tree/v2.16.1>2.16.1</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.15.0>2.15.0</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.14.1>2.14.1</a><br></td>
<td class="tg-7zrl">
<a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v2.15.0.0>2.15.0.0</a><br>
<a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v2.14.0.1>2.14.0.1</a><br>
<a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v2.13.0.0>2.13.0.0</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/pytorch/pytorch/tree/v2.2.1>2.2.1</a><br>
<a href=https://github.com/pytorch/pytorch/tree/v2.1.0>2.1.0</a><br>
<a href=https://github.com/pytorch/pytorch/tree/v2.0.1>2.0.1</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.2.0%2Bcpu>2.2.0</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.1.100%2Bcpu>2.1.100</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.0.100%2Bcpu>2.0.100</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/microsoft/onnxruntime/tree/v1.17.1>1.17.1</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.16.3>1.16.3</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.15.1>1.15.1</a><br></td>
<td class="tg-7zrl">
<a href=https://github.com/pytorch/pytorch/tree/v2.3.0>2.3.0</a><br>
<a href=https://github.com/pytorch/pytorch/tree/v2.2.2>2.2.2</a><br>
<a href=https://github.com/pytorch/pytorch/tree/v2.1.1>2.1.1</a><br></td>
<td class="tg-7zrl">
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.3.0%2Bcpu>2.3.0</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.2.0%2Bcpu>2.2.0</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.1.100%2Bcpu>2.1.100</a><br></td>
<td class="tg-7zrl">
<a href=https://github.com/microsoft/onnxruntime/tree/v1.18.0>1.18.0</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.17.3>1.17.3</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.16.3>1.16.3</a><br></td>
</tr>
</tbody>
</table>

> **Note:**
> Set the environment variable ``TF_ENABLE_ONEDNN_OPTS=1`` to enable oneDNN optimizations if you are using TensorFlow before v2.9. oneDNN is the default for TensorFlow since [v2.9](https://github.com/tensorflow/tensorflow/releases/tag/v2.9.0) ([Intel Cascade Lake](https://www.intel.com/content/www/us/en/products/platforms/details/cascade-lake.html) and newer CPUs).
Loading