From 99a370dd02dcf40e40062f92f09918edb421c4ec Mon Sep 17 00:00:00 2001 From: Preetha Veeramalai Date: Mon, 11 Jul 2022 23:24:12 +0530 Subject: [PATCH] Update readme for OVEP (#12122) * Add changes for training module in Readme * Update ReadMeOV.rst --- docs/python/ReadMeOV.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/python/ReadMeOV.rst b/docs/python/ReadMeOV.rst index 676f98714d..b9b794fadb 100644 --- a/docs/python/ReadMeOV.rst +++ b/docs/python/ReadMeOV.rst @@ -16,7 +16,7 @@ Requirements ^^^^^^^^^^^^ - Ubuntu 18.04, 20.04, RHEL(CPU only) or Windows 10 - 64 bit -- Python 3.7, 3.8 or 3.9 +- Python 3.7, 3.8 or 3.9 for Linux and only Python3.9 for Windows This package supports: - Intel® CPUs @@ -27,17 +27,21 @@ Please Note for VAD-M use Docker installation / Build from Source for Linux. ``pip3 install onnxruntime-openvino==1.12.0`` -Windows release supports only Python 3.9. Please install OpenVINO™ PyPi Package separately for Windows. +Please install OpenVINO™ PyPi Package separately for Windows. For installation instructions on Windows please refer to `OpenVINO™ Execution Provider for ONNX Runtime for Windows `_. -This **OpenVINO™ Execution Provider for ONNX Runtime** Linux Wheels comes with pre-built libraries of OpenVINO™ version 2022.1.0 meaning you do not have to install OpenVINO™ separately. CXX11_ABI flag for pre built OpenVINO™ libraries is 0. The package also comes with `ONNX Runtime Training module `_ to enable inferencing of torch models using `ORT `_. +**OpenVINO™ Execution Provider for ONNX Runtime** Linux Wheels comes with pre-built libraries of OpenVINO™ version 2022.1.0 eliminating the need to install OpenVINO™ separately. The OpenVINO™ libraries are prebuilt with CXX11_ABI flag set to 0. + +The package also includes module that is used by torch-ort-inference to accelerate inference for PyTorch models with OpenVINO Execution Provider. +See `torch-ort-inference `_ for more details. For more details on build and installation please refer to `Build `_. Usage ^^^^^ -By default, Intel® CPU is used to run inference. However, you can change the default option to either Intel® integrated GPU or Intel® VPU for AI inferencing. Invoke the following function to change the hardware on which inferencing is done. +By default, Intel® CPU is used to run inference. However, you can change the default option to either Intel® integrated GPU or Intel® VPU for AI inferencing. +Invoke `the provider config device type argument `_ to change the hardware on which inferencing is done. For more API calls and environment variables, see `Usage `_. @@ -76,4 +80,4 @@ How to Contribute We welcome community contributions to **OpenVINO™ Execution Provider for ONNX Runtime**. If you have an idea for improvement: * Share your proposal via `GitHub Issues `_. -* Submit a `Pull Request `_. \ No newline at end of file +* Submit a `Pull Request `_.