Update information for ROCm 5.4 for MIGraphX and ROCm Builds #13813
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,90 @@ | ||
| --- | ||
| title: AMD - MIGraphX | ||
| description: Instructions to execute ONNX Runtime with the AMD MIGraphX execution provider | ||
| parent: Execution Providers | ||
| nav_order: 10 | ||
| redirect_from: /docs/reference/execution-providers/MIGraphX-ExecutionProvider | ||
| --- | ||
|
|
||
| # MIGraphX Execution Provider | ||
| {: .no_toc } | ||
|
|
||
| The [MIGraphX](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/) execution provider uses AMD's Deep Learning graph optimization engine to accelerate ONNX model on AMD GPUs. | ||
|
|
||
| ## Contents | ||
| {: .no_toc } | ||
|
|
||
| * TOC placeholder | ||
faxu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| {:toc} | ||
| ## Install | ||
|
|
||
| **NOTE** Please make sure to install the proper version of Pytorch specified here [PyTorch Version](../install/#training-install-table-for-all-languages). | ||
|
|
||
| For Nightly PyTorch builds please see [Pytorch home](https://pytorch.org/) and select ROCm as the Compute Platform. | ||
|
|
||
| Pre-built binaries of ONNX Runtime with MIGraphX EP are published for most language bindings. Please reference [Install ORT](../install). | ||
|
|
||
| ## Requirements | ||
|
|
||
|
|
||
| |ONNX Runtime|MIGraphX| | ||
| |---|---| | ||
| |main|5.4| | ||
| |1.13|5.4| | ||
| |1.13|5.3.2| | ||
| |1.12|5.2.3| | ||
| |1.12|5.2| | ||
|
|
||
|
|
||
| ## Build | ||
| For build instructions, please see the [BUILD page](../build/eps.md#amd-migraphx). | ||
|
|
||
| ## Usage | ||
|
|
||
| ### C/C++ | ||
|
|
||
| ```c++ | ||
| Ort::Env env = Ort::Env{ORT_LOGGING_LEVEL_ERROR, "Default"}; | ||
| Ort::SessionOptions so; | ||
| int device_id = 0; | ||
| Ort::ThrowOnError(OrtSessionOptionsAppendExecutionProvider_MIGraphX(so, device_id)); | ||
| ``` | ||
|
|
||
| The C API details are [here](../get-started/with-c.md). | ||
|
|
||
| ### Python | ||
|
|
||
| When using the Python wheel from the ONNX Runtime build with MIGraphX execution provider, it will be automatically | ||
| prioritized over the default GPU or CPU execution providers. There is no need to separately register the execution | ||
| provider. | ||
|
|
||
| Python APIs details are [here](https://onnxruntime.ai/docs/api/python/api_summary.html). | ||
|
|
||
| *Note that the next release (ORT 1.10) will require explicitly setting the providers parameter if you want to use execution provider other than the default CPU provider when instantiating InferenceSession.* | ||
|
|
||
| You can check [here](https://github.com/scxiao/ort_test/tree/master/python/run_onnx) for a python script to run an | ||
| model on either the CPU or MIGraphX Execution Provider. | ||
|
|
||
|
|
||
| ## Configuration Options | ||
| MIGraphX providers an environment variable ORT_MIGRAPHX_FP16_ENABLE to enable the FP16 mode. | ||
|
|
||
| ## Performance Tuning | ||
| For performance tuning, please see guidance on this page: [ONNX Runtime Perf Tuning](../performance/tune-performance.md) | ||
|
|
||
| ## Samples | ||
|
|
||
| ### Python | ||
|
|
||
| ```python | ||
| import onnxruntime as ort | ||
|
|
||
| model_path = '<path to model>' | ||
|
|
||
| providers = [ | ||
| 'MIGraphXExecutionProvider', | ||
| 'CPUExecutionProvider', | ||
| ] | ||
|
|
||
| session = ort.InferenceSession(model_path, providers=providers) | ||
| ``` | ||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -245,12 +245,8 @@ The _location_ needs to be specified for any specific version other than the def | |
|
|
||
| ||Official build (location)|Nightly build (location)| | ||
| |---|---|---| | ||
|
Contributor
There was a problem hiding this comment. Is this intended to remove the CUDA builds? @ytaous / @PeixuanZuo |
||
| |PyTorch 1.11 (ROCm 5.2)||[onnxruntime_nightly_torch1110.rocm52](https://download.onnxruntime.ai/onnxruntime_stable_rocm52.html)| | ||
| |PyTorch 1.12.1 (ROCm 5.2.3)||[onnxruntime_nightly_torch1121.rocm523](https://download.onnxruntime.ai/onnxruntime_nightly_rocm523.html)| | ||
| |PyTorch 1.13 (ROCm 5.2.3)||[onnxruntime_nightly_torch1130.rocm523](https://download.onnxruntime.ai/onnxruntime_nightly_rocm523.html)| | ||
| |PyTorch 1.12.1 (ROCm 5.3.2)||[onnxruntime_nightly_torch1121.rocm532](https://download.onnxruntime.ai/onnxruntime_nightly_rocm532.html)| | ||
| |PyTorch 1.13.1(ROCm 5.4)||[onnxruntime_nightly_torch1131.rocm54](https://download.onnxruntime.ai/onnxruntime_nightly_rocm54.html)| | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is already a page for this EP here: https://onnxruntime.ai/docs/execution-providers/community-maintained/MIGraphX-ExecutionProvider.html
Can/should it be consolidated?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this to mirror what was done for the ROCm EP documentation. Should we be removing the other then is what you're saying?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consolidated info to this document page instead and removed the one under community-maintained.