Skip to content

Commit

Permalink
Bump version and Docs update (#1100)
Browse files Browse the repository at this point in the history
  • Loading branch information
chensuyue authored Jul 26, 2022
1 parent 07243af commit 98d829a
Show file tree
Hide file tree
Showing 6 changed files with 147 additions and 104 deletions.
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,20 @@ Intel® Neural Compressor has been one of the critical AI software components in

**Install on Linux**
```Shell
# install stable version from pip
# install stable basic version from pip
pip install neural-compressor
# install stable full version from pip (including GUI)
pip install neural-compressor-full

# install basic nightly version from pip
# install nightly basic version from pip
pip install -i https://test.pypi.org/simple/ neural-compressor
# install full nightly version from pip (including GUI)
# install nightly full version from pip (including GUI)
pip install -i https://test.pypi.org/simple/ neural-compressor-full

# install stable version from from conda
conda install neural-compressor -c conda-forge -c intel
# install stable basic version from from conda
conda install neural-compressor -c conda-forge -c intel
# install stable full version from from conda (including GUI)
conda install neural-compressor-full -c conda-forge -c intel
```
More installation methods can be found at [Installation Guide](./docs/installation_guide.md). Please check out our [FAQ](./docs/faq.md) for more details.

Expand Down Expand Up @@ -104,18 +108,18 @@ Intel® Neural Compressor supports systems based on [Intel 64 architecture or co
<td class="tg-7zrl"><a href=https://github.com/tensorflow/tensorflow/tree/v2.9.1>2.9.1</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.8.2>2.8.2</a><br>
<a href=https://github.com/tensorflow/tensorflow/tree/v2.7.3>2.7.3</a><br>
<td class="tg-7zrl"><a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.8.0>2.8.0</a><br>
<td class="tg-7zrl"><a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.9.1>2.9.1</a><br>
<a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.8.0>2.8.0</a><br>
<a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.7.0>2.7.0</a><br>
<a href=https://github.com/Intel-tensorflow/tensorflow/tree/v1.15.0up3>1.15.0UP3</a></td>
<td class="tg-7zrl"><a href=https://download.pytorch.org/whl/torch_stable.html>1.11.0+cpu</a><br>
<a href=https://download.pytorch.org/whl/torch_stable.html>1.10.0+cpu</a><br>
<a href=https://download.pytorch.org/whl/torch_stable.html>1.9.0+cpu</a></td>
<td class="tg-7zrl"><a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.11.0>1.11.0</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.10.0>1.10.0</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.9.0>1.9.0</a></td>
<td class="tg-7zrl"><a href=https://github.com/microsoft/onnxruntime/tree/v1.10.0>1.10.0</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.9.0>1.9.0</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.8.0>1.8.0</a></td>
<td class="tg-7zrl"><a href=https://download.pytorch.org/whl/torch_stable.html>1.12.0+cpu</a><br>
<a href=https://download.pytorch.org/whl/torch_stable.html>1.11.0+cpu</a><br>
<a href=https://download.pytorch.org/whl/torch_stable.html>1.10.0+cpu</a></td>
<td class="tg-7zrl"><a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.12.0>1.12.0</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.10.0>1.11.0</a><br>
<a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.9.0>1.10.0</a></td>
<td class="tg-7zrl"><a href=https://github.com/microsoft/onnxruntime/tree/v1.11.0>1.11.0</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.10.0>1.10.0</a><br>
<a href=https://github.com/microsoft/onnxruntime/tree/v1.9.0>1.9.0</a></td>
<td class="tg-7zrl"><a href=https://github.com/apache/incubator-mxnet/tree/1.8.0>1.8.0</a><br>
<a href=https://github.com/apache/incubator-mxnet/tree/1.7.0>1.7.0</a><br>
<a href=https://github.com/apache/incubator-mxnet/tree/1.6.0>1.6.0</a></td>
Expand Down
2 changes: 1 addition & 1 deletion conda_meta/basic/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% set version = "1.12" %}
{% set version = "1.13" %}
{% set buildnumber = 0 %}
package:
name: neural-compressor
Expand Down
2 changes: 1 addition & 1 deletion conda_meta/full/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% set version = "1.12" %}
{% set version = "1.13" %}
{% set buildnumber = 0 %}
package:
name: neural-compressor-full
Expand Down
20 changes: 9 additions & 11 deletions docs/installation_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,25 @@ The following prerequisites and requirements must be satisfied for a successful

- Python version: 3.7 or 3.8 or 3.9 or 3.10

- C++ compiler: 7.2.1 or above

- CMake: 3.12 or above

> If you get some build issues, please check [frequently asked questions](faq.md) at first.
### Option 1 Install from binary

```Shell
# install stable version from pip
# install stable basic version from pip
pip install neural-compressor
# install stable full version from pip (including GUI)
pip install neural-compressor-full

# install basic nightly version from pip
# install nightly basic version from pip
pip install -i https://test.pypi.org/simple/ neural-compressor
# install full nightly version from pip (including GUI)
# install nightly full version from pip (including GUI)
pip install -i https://test.pypi.org/simple/ neural-compressor-full

# install stable version from from conda
conda install neural-compressor -c conda-forge -c intel
# install stable basic version from from conda
conda install neural-compressor -c conda-forge -c intel
# install stable full version from from conda (including GUI)
conda install neural-compressor-full -c conda-forge -c intel
```

### Option 2 Install from source
Expand Down Expand Up @@ -87,8 +87,6 @@ The following prerequisites and requirements must be satisfied for a successful
```shell
git clone https://github.com/intel/neural-compressor.git
cd neural-compressor
git submodule sync
git submodule update --init --recursive
pip install -r requirements.txt
python setup.py install
```
2 changes: 1 addition & 1 deletion neural_compressor/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.

__version__ = "1.12"
__version__ = "1.13"
Loading

0 comments on commit 98d829a

Please sign in to comment.