Skip to content

Commit d9a00ed

Browse files
Update openvino doc update for ORT 1.23 (#26412)
### Description Update documentation with all updated openvino build and provider options --------- Co-authored-by: Jaswanth Gannamaneni <[email protected]>
1 parent 069ff7d commit d9a00ed

File tree

2 files changed

+407
-240
lines changed

2 files changed

+407
-240
lines changed

docs/build/eps.md

Lines changed: 20 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -337,19 +337,20 @@ See more information on the OpenVINO™ Execution Provider [here](../execution-p
337337
### Prerequisites
338338
{: .no_toc }
339339

340-
1. Install the OpenVINO™ offline/online installer from Intel<sup>®</sup> Distribution of OpenVINO™<sup>TM</sup> Toolkit **Release 2024.3** for the appropriate OS and target hardware:
341-
* [Windows - CPU, GPU, NPU](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html?PACKAGE=OPENVINO_BASE&VERSION=v_2024_3_0&OP_SYSTEM=WINDOWS&DISTRIBUTION=ARCHIVE).
342-
* [Linux - CPU, GPU, NPU](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html?PACKAGE=OPENVINO_BASE&VERSION=v_2024_3_0&OP_SYSTEM=LINUX&DISTRIBUTION=ARCHIVE)
343-
344-
Follow [documentation](https://docs.openvino.ai/2024/home.html) for detailed instructions.
345-
346-
*2024.5 is the current recommended OpenVINO™ version. [OpenVINO™ 2024.5](https://docs.openvino.ai/2024/index.html) is minimal OpenVINO™ version requirement.*
340+
1. Install the OpenVINO™ offline/online installer from Intel<sup>®</sup> Distribution of OpenVINO™<sup>TM</sup> Toolkit **Release 2025.3** for the appropriate OS and target hardware:
341+
* [Windows - CPU, GPU, NPU](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html?PACKAGE=OPENVINO_BASE&VERSION=v_2025_3_0&OP_SYSTEM=WINDOWS&DISTRIBUTION=ARCHIVE).
342+
* [Linux - CPU, GPU, NPU](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html?PACKAGE=OPENVINO_BASE&VERSION=v_2025_3_0&OP_SYSTEM=LINUX&DISTRIBUTION=ARCHIVE)
343+
344+
Follow [documentation](https://docs.openvino.ai/2025/index.html) for detailed instructions.
345+
346+
*2025.3 is the current recommended OpenVINO™ version. [OpenVINO™ 2025.0](https://docs.openvino.ai/2025/index.html) is minimal OpenVINO™ version requirement.*
347347

348-
2. Configure the target hardware with specific follow on instructions:
349-
* To configure Intel<sup>®</sup> Processor Graphics(GPU) please follow these instructions: [Windows](https://docs.openvino.ai/2024/get-started/configurations/configurations-intel-gpu.html#windows), [Linux](https://docs.openvino.ai/2024/get-started/configurations/configurations-intel-gpu.html#linux)
348+
2. Install CMake 3.28 or higher. Download from the [official CMake website](https://cmake.org/download/).
350349

350+
3. Configure the target hardware with specific follow on instructions:
351+
* To configure Intel<sup>®</sup> Processor Graphics(GPU) please follow these instructions: [Windows](https://docs.openvino.ai/2025/get-started/install-openvino/configurations/configurations-intel-gpu.html#windows), [Linux](https://docs.openvino.ai/2025/get-started/install-openvino/configurations/configurations-intel-gpu.html#linux)
351352

352-
3. Initialize the OpenVINO™ environment by running the setupvars script as shown below. This is a required step:
353+
4. Initialize the OpenVINO™ environment by running the setupvars script as shown below. This is a required step:
353354
* For Windows:
354355
```
355356
C:\<openvino_install_directory>\setupvars.bat
@@ -358,30 +359,30 @@ See more information on the OpenVINO™ Execution Provider [here](../execution-p
358359
```
359360
$ source <openvino_install_directory>/setupvars.sh
360361
```
361-
**Note:** If you are using a dockerfile to use OpenVINO™ Execution Provider, sourcing OpenVINO™ won't be possible within the dockerfile. You would have to explicitly set the LD_LIBRARY_PATH to point to OpenVINO™ libraries location. Refer our [dockerfile](https://github.com/microsoft/onnxruntime/blob/main/dockerfiles/Dockerfile.openvino).
362+
362363

363364
### Build Instructions
364365
{: .no_toc }
365366

366367
#### Windows
367368

368369
```
369-
.\build.bat --config RelWithDebInfo --use_openvino <hardware_option> --build_shared_lib --build_wheel
370+
.\build.bat --config Release --use_openvino <hardware_option> --build_shared_lib --build_wheel
370371
```
371372

372373
*Note: The default Windows CMake Generator is Visual Studio 2019, but you can also use the newer Visual Studio 2022 by passing `--cmake_generator "Visual Studio 17 2022"` to `.\build.bat`*
373374

374375
#### Linux
375376

376377
```bash
377-
./build.sh --config RelWithDebInfo --use_openvino <hardware_option> --build_shared_lib --build_wheel
378+
./build.sh --config Release --use_openvino <hardware_option> --build_shared_lib --build_wheel
378379
```
379380

380381
* `--build_wheel` Creates python wheel file in dist/ folder. Enable it when building from source.
381382
* `--use_openvino` builds the OpenVINO™ Execution Provider in ONNX Runtime.
382-
* `<hardware_option>`: Specifies the default hardware target for building OpenVINO™ Execution Provider. This can be overriden dynamically at runtime with another option (refer to [OpenVINO™-ExecutionProvider](../execution-providers/OpenVINO-ExecutionProvider.md#summary-of-options) for more details on dynamic device selection). Below are the options for different Intel target devices.
383+
* `<hardware_option>`: Specifies the default hardware target for building OpenVINO™ Execution Provider. This can be overriden dynamically at runtime with another option (refer to [OpenVINO™-ExecutionProvider](../execution-providers/OpenVINO-ExecutionProvider.md#configuration-options) for more details on dynamic device selection). Below are the options for different Intel target devices.
383384

384-
Refer to [Intel GPU device naming convention](https://docs.openvino.ai/2024/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.html#device-naming-convention) for specifying the correct hardware target in cases where both integrated and discrete GPU's co-exist.
385+
Refer to [Intel GPU device naming convention](https://docs.openvino.ai/2025/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.html#device-naming-convention) for specifying the correct hardware target in cases where both integrated and discrete GPU's co-exist.
385386
386387
| Hardware Option | Target Device |
387388
| --------------- | ------------------------|
@@ -390,37 +391,20 @@ Refer to [Intel GPU device naming convention](https://docs.openvino.ai/2024/open
390391
| <code>GPU.0</code> | Intel<sup>®</sup> Integrated Graphics |
391392
| <code>GPU.1</code> | Intel<sup>®</sup> Discrete Graphics |
392393
| <code>NPU</code> | Intel<sup>®</sup> Neural Processor Unit |
393-
| <code>HETERO:DEVICE_TYPE_1,DEVICE_TYPE_2,DEVICE_TYPE_3...</code> | All Intel<sup>®</sup> silicons mentioned above |
394-
| <code>MULTI:DEVICE_TYPE_1,DEVICE_TYPE_2,DEVICE_TYPE_3...</code> | All Intel<sup>®</sup> silicons mentioned above |
395-
| <code>AUTO:DEVICE_TYPE_1,DEVICE_TYPE_2,DEVICE_TYPE_3...</code> | All Intel<sup>®</sup> silicons mentioned above |
396-
397-
Specifying Hardware Target for HETERO or Multi or AUTO device Build:
398-
399-
HETERO:DEVICE_TYPE_1,DEVICE_TYPE_2,DEVICE_TYPE_3...
400-
The DEVICE_TYPE can be any of these devices from this list ['CPU','GPU', 'NPU']
401394
402-
A minimum of two device's should be specified for a valid HETERO or MULTI or AUTO device build.
403-
404-
```
405-
Example's: HETERO:GPU,CPU or AUTO:GPU,CPU or MULTI:GPU,CPU
406-
```
407395
408396
#### Disable subgraph partition Feature
409-
* Builds the OpenVINO™ Execution Provider in ONNX Runtime with sub graph partitioning disabled.
410-
411-
* With this option enabled. Fully supported models run on OpenVINO Execution Provider else they completely fall back to default CPU EP.
397+
* Builds the OpenVINO™ Execution Provider in ONNX Runtime with graph partitioning disabled, which will run fully supported models on OpenVINO Execution Provider else they completely fall back to default CPU EP,
412398
413399
* To enable this feature during build time. Use `--use_openvino ` `<hardware_option>_NO_PARTITION`
414400
415401
```
416-
Usage: --use_openvino CPU_FP32_NO_PARTITION or --use_openvino GPU_FP32_NO_PARTITION or
417-
--use_openvino GPU_FP16_NO_PARTITION
402+
Usage: --use_openvino CPU_NO_PARTITION or --use_openvino GPU_NO_PARTITION or --use_openvino NPU_NO_PARTITION
418403
```
419404
420-
For more information on OpenVINO™ Execution Provider&#39;s ONNX Layer support, Topology support, and Intel hardware enabled, please refer to the document [OpenVINO™-ExecutionProvider](../execution-providers/OpenVINO-ExecutionProvider.md)
405+
For more information on OpenVINO™ Execution Provider&#39;s ONNX Layer support, Topology support, and Intel hardware enabled, please refer to the document [OpenVINO™-ExecutionProvider](../execution-providers/OpenVINO-ExecutionProvider.md#support-coverage)
421406
422407
---
423-
424408
## QNN
425409
See more information on the QNN execution provider [here](../execution-providers/QNN-ExecutionProvider.md).
426410
@@ -895,4 +879,4 @@ build.bat --config <Release|Debug|RelWithDebInfo> --build_shared_lib --build_whe
895879

896880
```bash
897881
./build.sh --config <Release|Debug|RelWithDebInfo> --build_shared_lib --build_wheel --use_azure
898-
```
882+
```

0 commit comments

Comments
 (0)