microsoft / microsoft/onnxruntime

[Documentation] PR #25181 is undocumented

Open
#26,205 1 comment 0 reactions 0 assignees View on GitHub
documentation ep:ROCm
Dominant language
C++
Stars
21.9k
Forks
4.2k
Avg merge
4d 11h
Merged PRs (30d)
184

Description

### Describe the documentation issue

Hi all,

I've been trying to build against ROCm for the better part of a week now, from [This Huggingface tutorial](https://huggingface.co/docs/optimum-onnx/onnxruntime/usage_guides/amdgpu#21-pytorch-with-rocm-support). Obviously that page is out of date and out of the domain of the Onnx team, but when the build failed I checked the [Onnx build documentation](https://onnxruntime.ai/docs/build/eps.html#amd-rocm) which claims the ROCm stack is still supported. `tools/ci_build/build.py` goes off without a hitch, up until `setup.py` is run as a subprocess, which tells me that `--use_rocm` isn't recognized. I looked at the source of `setup.py`, and couldn't figure out why all ROCm flag parsing had been removed. It wasn't until I checked the commit history and searched for "ROCm" that I found my answer.

Is there any reason `tools/ci_build/build.py` doesn't `raise` an `Exception` right off the bat? At the least, I would say the documentation website should mark the flags as deprecated, if some valid historical ROCm targets still exist

Here's the PR itself: https://github.com/microsoft/onnxruntime/pull/25181

### Page / URL

https://onnxruntime.ai/docs/build/eps.html#amd-rocm

Contributor guide

Open the contributing guide

Research direction

Read PR #25181 and compare its ROCm changes with the AMD ROCm section at https://onnxruntime.ai/docs/build/eps.html#amd-rocm. Then inspect tools/ci_build/build.py and setup.py to understand how the unsupported --use_rocm flag is handled. Done means the documentation and reported build behavior agree about ROCm support and deprecated flags.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.