Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Install page missing instructions for onnxruntime-rocm #21036

Open
shaunclimbon opened this issue Jun 13, 2024 · 2 comments
Open
Assignees
Labels
documentation improvements or additions to documentation; typically submitted using template ep:ROCm questions/issues related to ROCm execution provider

Comments

@shaunclimbon
Copy link

Describe the documentation issue

The installation matrix provides correct guidance for ORT with ROCm (i.e. build from source) but the actual install documentation is missing it. In particular, the Python Installs section covers ORT>CPU and ORT>GPU>CUDA but not ORT>GPU>ROCm. Albeit Linux specific, it still seems like this info should be present.

As of reporting this, building the onnxruntime-rocm wheel was the recommended route (as documented here) but it's worth noting that I found pre-built wheels in a couple locations:

Page / URL

https://onnxruntime.ai/docs/install/

@shaunclimbon shaunclimbon added the documentation improvements or additions to documentation; typically submitted using template label Jun 13, 2024
@github-actions github-actions bot added ep:CUDA issues related to the CUDA execution provider ep:ROCm questions/issues related to ROCm execution provider labels Jun 13, 2024
@tianleiwu tianleiwu removed the ep:CUDA issues related to the CUDA execution provider label Jun 13, 2024
@MaanavD
Copy link
Contributor

MaanavD commented Jun 13, 2024

Hey @shaunclimbon , do you have an email I could follow up with you on? I'm happy to add these missing instructions, but I want to make sure we accurately represent them in a way you're happy with :)

Alternatively,

I'm assuming you want a section in the first link for
Install ONNX Runtime GPU (ROCm)

with instructions along the lines of

Prerequisites
Install ROCm
The ROCm execution provider for ONNX Runtime is built and tested with ROCm6.0.0

Build Instructions
LINUX
./build.sh --config <Release|Debug|RelWithDebInfo> --use_rocm --rocm_home

See more information on the ROCm Execution Provider here.

@shaunpamd
Copy link

Thanks for the prompt response MaanavD. Yes, above suggestions looks good to me. Mostly just trying to help users like me that miss the installation matrix. And I figure the links to pre-built wheels could be useful to others that come across this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation improvements or additions to documentation; typically submitted using template ep:ROCm questions/issues related to ROCm execution provider
Projects
None yet
Development

No branches or pull requests

4 participants