Skip to content

Commit

Permalink
Update readme and installation (openvinotoolkit#3111)
Browse files Browse the repository at this point in the history
### Changes

Update readme.md and installation.md
  • Loading branch information
AlexanderDokuchaev authored Dec 4, 2024
1 parent af4fec4 commit 75ba2f7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
[![Apache License Version 2.0](https://img.shields.io/badge/license-Apache_2.0-green.svg)](LICENSE)
[![PyPI Downloads](https://static.pepy.tech/badge/nncf)](https://pypi.org/project/nncf/)

![Python](https://img.shields.io/badge/python-3.9+-blue)
![Backends](https://img.shields.io/badge/backends-openvino_|_pytorch_|_onnx_|_tensorflow-orange)
![OS](https://img.shields.io/badge/OS-Linux_|_Windows_|_MacOS-blue)

</div>

Neural Network Compression Framework (NNCF) provides a suite of post-training and training-time algorithms for optimizing inference of neural networks in [OpenVINO&trade;](https://docs.openvino.ai) with a minimal accuracy drop.
Expand Down Expand Up @@ -467,17 +471,8 @@ NNCF is also available via [conda](https://anaconda.org/conda-forge/nncf):
conda install -c conda-forge nncf
```

### System requirements

- Ubuntu\* 18.04 or later (64-bit)
- Python\* 3.9 or later
- Supported frameworks:
- PyTorch\* >=2.4, <2.6
- TensorFlow\* >=2.8.4, <=2.15.1
- ONNX\* ==1.17.0
- OpenVINO\* >=2022.3.0

This repository is tested on Python* 3.10.14, PyTorch* 2.5.0 (NVidia CUDA\* Toolkit 12.4) and TensorFlow* 2.12.1 (NVidia CUDA\* Toolkit 11.8).
System requirements of NNCF correspond to the used backend. System requirements for each backend and
the matrix of corresponding versions can be found in [installation.md](./docs/Installation.md).

## NNCF Compressed NNCF Model Zoo

Expand Down
10 changes: 9 additions & 1 deletion docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

We suggest to install or use the package in the [Python virtual environment](https://docs.python.org/3/tutorial/venv.html).

If you want to optimize a model from PyTorch, install PyTorch by following [PyTorch installation guide](https://pytorch.org/get-started/locally/#start-locally). For other backend follow: [TensorFlow installation guide](https://www.tensorflow.org/install/), [ONNX installation guide](https://onnxruntime.ai/docs/install/), [OpenVINO installation guide](https://docs.openvino.ai/latest/openvino_docs_install_guides_overview.html).
NNCF supports multiple backends. Follow the corresponding installation guides and ensure your system meets
the required specifications for your chosen backend:

- OpenVINO&trade;: [Install Guide](https://docs.openvino.ai/2024/get-started/install-openvino.html), [System Requirements](https://docs.openvino.ai/2024/about-openvino/release-notes-openvino/system-requirements.html)
- ONNX: [Install Guide](https://onnxruntime.ai/docs/install/)
- PyTorch: [Install Guide](https://pytorch.org/get-started/locally/#start-locally)
- TensorFlow: [Install Guide](https://www.tensorflow.org/install/)

## As a PyPI package

Expand Down Expand Up @@ -58,3 +64,5 @@ as well as the supported versions of Python:
| `2.4.0` | `2022.1.0` | `1.12.1` | `1.12.0` | `2.8.2` | `3.8` |

> (*) Python 3.9 or higher is required for TensorFlow 2.15.1
This repository is tested on Python* 3.10.14, PyTorch* 2.5.0 (NVidia CUDA\* Toolkit 12.4) and TensorFlow* 2.12.1 (NVidia CUDA\* Toolkit 11.8).

0 comments on commit 75ba2f7

Please sign in to comment.