Skip to content

docs: add onnxruntime-openvino/OpenVINO version pairing note - #1893

Open
dunegym wants to merge 1 commit into
hacksider:mainfrom
dunegym:docs/openvino-version-pairing
Open

docs: add onnxruntime-openvino/OpenVINO version pairing note#1893
dunegym wants to merge 1 commit into
hacksider:mainfrom
dunegym:docs/openvino-version-pairing

Conversation

@dunegym

@dunegym dunegym commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a note to the OpenVINO Execution Provider (Intel) section of the README clarifying that onnxruntime-openvino newer than 1.21.0 must be installed together with the openvino package, and that the two versions must match one-to-one.

Included supported pairings (per the official onnxruntime docs):

onnxruntime-openvino OpenVINO
1.24.1 2025.4.1
1.23.0 2025.3
1.22.0 2025.1

With an install example and a link to the OpenVINO Execution Provider requirements.

Why

Without the matching openvino package installed, newer onnxruntime-openvino versions fail at runtime (missing OpenVINO DLLs), which is confusing for users following the Intel execution-provider setup.

Summary by Sourcery

Documentation:

  • Add README guidance on one-to-one version pairing between onnxruntime-openvino (>1.21.0) and OpenVINO, including a supported version matrix, install example, and link to official requirements.

@sourcery-ai

sourcery-ai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds documentation to the README clarifying version pairing requirements between onnxruntime-openvino and openvino for the OpenVINO Execution Provider, including a small compatibility table, an installation example, and a link to official requirements.

File-Level Changes

Change Details Files
Clarify and document required version pairing between onnxruntime-openvino and openvino in the OpenVINO Execution Provider setup instructions.
  • Added a note that onnxruntime-openvino versions newer than 1.21.0 must be installed together with the openvino package and that their versions must match one-to-one.
  • Introduced a small compatibility table listing supported onnxruntime-openvino and openvino version pairings (1.24.1/2025.4.1, 1.23.0/2025.3, 1.22.0/2025.1).
  • Added a bash installation example showing how to install a matching openvino and onnxruntime-openvino version pair.
  • Linked to the official OpenVINO Execution Provider requirements page for complete version-mapping details.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 1 issue, and left some high level feedback:

  • Since the OpenVINO/onnxruntime-openvino version matrix is likely to change over time, consider explicitly noting that the table is illustrative and that the link to the official requirements is the source of truth to avoid future drift.
  • To make the compatibility rule clearer, you might replace "correspond one-to-one" with more explicit wording like "must be installed at the specific version pairings listed below" so users don’t misinterpret it as "same version number".
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Since the OpenVINO/onnxruntime-openvino version matrix is likely to change over time, consider explicitly noting that the table is illustrative and that the link to the official requirements is the source of truth to avoid future drift.
- To make the compatibility rule clearer, you might replace "correspond one-to-one" with more explicit wording like "must be installed at the specific version pairings listed below" so users don’t misinterpret it as "same version number".

## Individual Comments

### Comment 1
<location path="README.md" line_range="316" />
<code_context>
 pip install onnxruntime-openvino==1.21.0
 ```

+**Note:** `onnxruntime-openvino` newer than 1.21.0 must be installed together with `openvino`, and the two versions must correspond one-to-one. The supported pairings are:
+
+| onnxruntime-openvino | OpenVINO |
</code_context>
<issue_to_address>
**suggestion (typo):** Consider clarifying the phrase by adding a noun after `onnxruntime-openvino` (e.g., "versions").

The phrase "`onnxruntime-openvino` newer than 1.21.0" is grammatically awkward. Consider "Versions of `onnxruntime-openvino` newer than 1.21.0" or "Any `onnxruntime-openvino` version newer than 1.21.0" for clearer wording.

```suggestion
**Note:** Versions of `onnxruntime-openvino` newer than 1.21.0 must be installed together with `openvino`, and the two versions must correspond one-to-one. The supported pairings are:
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread README.md
pip install onnxruntime-openvino==1.21.0
```

**Note:** `onnxruntime-openvino` newer than 1.21.0 must be installed together with `openvino`, and the two versions must correspond one-to-one. The supported pairings are:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (typo): Consider clarifying the phrase by adding a noun after onnxruntime-openvino (e.g., "versions").

The phrase "onnxruntime-openvino newer than 1.21.0" is grammatically awkward. Consider "Versions of onnxruntime-openvino newer than 1.21.0" or "Any onnxruntime-openvino version newer than 1.21.0" for clearer wording.

Suggested change
**Note:** `onnxruntime-openvino` newer than 1.21.0 must be installed together with `openvino`, and the two versions must correspond one-to-one. The supported pairings are:
**Note:** Versions of `onnxruntime-openvino` newer than 1.21.0 must be installed together with `openvino`, and the two versions must correspond one-to-one. The supported pairings are:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant