Skip to content
Prev Previous commit
Next Next commit
update install readme
Signed-off-by: chensuyue <[email protected]>
  • Loading branch information
chensuyue committed Jul 17, 2024
commit 1b00d0a3dd3e32fc55cec1b97e29aad925c54e4f
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ In particular, the tool provides the key features, typical examples, and open co
* Collaborate with cloud marketplaces such as [Google Cloud Platform](https://console.cloud.google.com/marketplace/product/bitnami-launchpad/inc-tensorflow-intel?project=verdant-sensor-286207), [Amazon Web Services](https://aws.amazon.com/marketplace/pp/prodview-yjyh2xmggbmga#pdp-support), and [Azure](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/bitnami.inc-tensorflow-intel), software platforms such as [Alibaba Cloud](https://www.intel.com/content/www/us/en/developer/articles/technical/quantize-ai-by-oneapi-analytics-on-alibaba-cloud.html), [Tencent TACO](https://new.qq.com/rain/a/20221202A00B9S00) and [Microsoft Olive](https://github.com/microsoft/Olive), and open AI ecosystem such as [Hugging Face](https://huggingface.co/blog/intel), [PyTorch](https://pytorch.org/tutorials/recipes/intel_neural_compressor_for_pytorch.html), [ONNX](https://github.com/onnx/models#models), [ONNX Runtime](https://github.com/microsoft/onnxruntime), and [Lightning AI](https://github.com/Lightning-AI/lightning/blob/master/docs/source-pytorch/advanced/post_training_quantization.rst)

## What's New
* [2024/07] From 3.0 release, 3.X framework extension API is recommended to be used for LLM quantization.
* [2024/07] From 3.0 release, framework extension API is recommended to be used for LLM quantization.

## Installation

### Install from pypi
```Shell
# Install 2.X API + PyTorch extension API + PyTorch dependency
# Install 2.X API + Framework extension API + PyTorch dependency
pip install neural-compressor[pt]
# Install 2.X API + TensorFlow extension API + TensorFlow dependency
# Install 2.X API + Framework extension API + TensorFlow dependency
pip install neural-compressor[tf]
```
> **Note**:
Expand Down
47 changes: 23 additions & 24 deletions docs/source/installation_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,28 +29,27 @@ The following prerequisites and requirements must be satisfied for a successful

### Install from Binary
- Install from Pypi
```Shell
# install stable basic version from pypi
pip install neural-compressor
```
```Shell
# [Experimental] install stable basic + PyTorch framework extension API from pypi
pip install neural-compressor[pt]
```
```Shell
# [Experimental] install stable basic + TensorFlow framework extension API from pypi
pip install neural-compressor[tf]
```

- Install from test Pypi
```Shell
# 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
```
```Shell
# Install 2.X API + Framework extension API + PyTorch dependency
pip install neural-compressor[pt]
```
```Shell
# Install 2.X API + Framework extension API + TensorFlow dependency
pip install neural-compressor[tf]
```
```Shell
# Install 2.X API + Framework extension API
# With with install CMD, some dependencies for framework extension API not installed, you can install them separately by `pip install -r requirements_pt.txt` or `pip install -r requirements_tf.txt`.
pip install neural-compressor
```
```Shell
# Framework extension API + TensorFlow dependency
pip install neural-compressor-pt
```
```Shell
# Framework extension API + TensorFlow dependency
pip install neural-compressor-tf
```

### Install from Source

Expand All @@ -59,8 +58,8 @@ The following prerequisites and requirements must be satisfied for a successful
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
[optional] pip install -r requirements_pt.txt # for PyTorch framework extension API
[optional] pip install -r requirements_tf.txt # for TensorFlow framework extension API
```

### Install from AI Kit
Expand Down