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.

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 readme for v2.3 release #1258

Merged
merged 11 commits into from
Sep 15, 2023
14 changes: 10 additions & 4 deletions README.md
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.7%2B-blue)](https://github.com/intel/neural-compressor)
[![version](https://img.shields.io/badge/release-2.2-green)](https://github.com/intel/neural-compressor/releases)
[![version](https://img.shields.io/badge/release-2.3-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 Expand Up @@ -155,6 +155,12 @@ q_model = fit(
* [Legal Information](./docs/source/legal_information.md)
* [Security Policy](SECURITY.md)

## Research Collaborations

Welcome to raise any interesting research ideas on model compression techniques and feel free to reach us ([[email protected]](mailto:[email protected])). Look forward to our collaborations on Intel Neural Compressor!
## Communication
- [GitHub Issues](https://github.com/intel/neural-compressor/issues): mainly for bugs report, new feature request, question asking, etc.
- [Email](mailto:[email protected]): welcome to raise any interesting research ideas on model compression techniques by email for collaborations.
- WeChat group: scan the QA code to join the technical discussion.
<div align=center>
<a target="_blank" href="/docs/source/imgs/wechat_group.jpg">
<img src="/docs/source/imgs/wechat_group.jpg" width=200 height=200 alt="Pruning schedule">
</a>
</div>
Binary file added docs/source/imgs/wechat_group.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 12 additions & 11 deletions docs/source/installation_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,21 +145,22 @@ The following prerequisites and requirements must be satisfied for a successful
<tbody>
<tr align="center">
<th>Version</th>
<td class="tg-7zrl"><a href=https://github.com/tensorflow/tensorflow/tree/v2.12.0>2.12.0</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.11.0>2.11.0</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.10.1>2.10.1</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.12.0>2.12.0</a><br>
<a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.11.0>2.11.0</a><br>
<a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.10.0>2.10.0</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v1.2.0>1.2.0</a><br>
<td class="tg-7zrl"> <a href=https://github.com/tensorflow/tensorflow/tree/v2.13.0>2.13.0</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.12.1>2.12.1</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.11.1>2.11.1</a><br></td>
<td class="tg-7zrl"> <a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.13.0>2.13.0</a><br>
<a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.12.0>2.12.0</a><br>
<a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.11.0>2.11.0</a><br></td>
<td class="tg-7zrl"> <a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v2.13.0.0>v2.13.0.0</a><br>
<a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v1.2.0>1.2.0</a><br>
<a href=https://github.com/intel/intel-extension-for-tensorflow/tree/v1.1.0>1.1.0</a></td>
<td class="tg-7zrl"><a href=https://download.pytorch.org/whl/torch_stable.html>2.0.1+cpu</a><br>
<a href=https://download.pytorch.org/whl/torch_stable.html>1.13.1+cpu</a><br>
<a href=https://download.pytorch.org/whl/torch_stable.html>1.12.1+cpu</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/pytorch/pytorch/tree/v2.0.1>2.0.1+cpu</a><br>
<a href=https://github.com/pytorch/pytorch/tree/v1.13.1>1.13.1+cpu</a><br>
<a href=https://github.com/pytorch/pytorch/tree/v1.12.1>1.12.1+cpu</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/intel/intel-extension-for-pytorch/tree/v2.0.100+cpu>2.0.1+cpu</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.13.100+cpu>1.13.1+cpu</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.12.100>1.12.1+cpu</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/microsoft/onnxruntime/tree/v1.15.0>1.15.0</a><br>
<td class="tg-7zrl"><a href=https://github.com/microsoft/onnxruntime/tree/v1.15.1>1.15.1</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.14.1>1.14.1</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.13.1>1.13.1</a><br></td>
<td class="tg-7zrl"><a href=https://github.com/apache/incubator-mxnet/tree/1.9.1>1.9.1</a><br></td>
Expand Down
19 changes: 12 additions & 7 deletions third-party-programs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,9 @@ terms are listed below.
socket.io
Copyright (c) 2014-2018 Automattic <[email protected]>

sass
Copyright (c) 2016, Google Inc.


The MIT License (MIT)

Expand Down Expand Up @@ -1693,7 +1696,7 @@ terms are listed below.
limitations under the License.

======================================================================================
BSD License
BSD Lisence
chensuyue marked this conversation as resolved.
Show resolved Hide resolved

--------------------------------------------------------------------------------------
1. FBGEMM from Facebook
Expand Down Expand Up @@ -1840,13 +1843,16 @@ Code generated by the Protocol Buffer compiler is owned by the owner
of the input file used when generating it. This code is not
standalone and requires a support library to be linked with it. This
support library is itself covered by the above license.

-------------------------------------------------------------
7. Hardware-Aware Transformer software
8. Hardware-Aware Transformer software
Copyright (c) 2020, Hanrui Wang, Zhanghao Wu, Zhijian Liu, Han Cai,
Ligeng Zhu, Chuang Gan and Song Han
All rights reserved.

------------ LICENSE For Hardware-Aware Transformer software ---------------
Copyright (c) 2020, Hanrui Wang, Zhanghao Wu, Zhijian Liu, Han Cai,
Ligeng Zhu, Chuang Gan and Song Han
All rights reserved.
css-select
Copyright (c) Felix Böhm
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Expand Down Expand Up @@ -1893,7 +1899,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


------------------------------------------------------------------

The following third party programs have their own third party program files. These additional
Expand Down