docs: add onnxruntime-openvino/OpenVINO version pairing note - #1893
Open
dunegym wants to merge 1 commit into
Open
docs: add onnxruntime-openvino/OpenVINO version pairing note#1893dunegym wants to merge 1 commit into
dunegym wants to merge 1 commit into
Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds documentation to the README clarifying version pairing requirements between File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
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>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| 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: |
Contributor
There was a problem hiding this comment.
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: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a note to the OpenVINO Execution Provider (Intel) section of the README clarifying that
onnxruntime-openvinonewer than 1.21.0 must be installed together with theopenvinopackage, and that the two versions must match one-to-one.Included supported pairings (per the official onnxruntime docs):
With an install example and a link to the OpenVINO Execution Provider requirements.
Why
Without the matching
openvinopackage installed, neweronnxruntime-openvinoversions fail at runtime (missing OpenVINO DLLs), which is confusing for users following the Intel execution-provider setup.Summary by Sourcery
Documentation: