fix(rocprofiler-compute): Gate rocprof-compute analyze deps behind an opt-in compute-analyze extra by vedithal-amd · Pull Request #7002 · ROCm/TheRock

vedithal-amd · 2026-07-30T18:47:44Z

Motivation

rocprof-compute analyze needs dash, pandas and numpy; rocprof-compute profile needs nothing. The rocm-profiler wheel declares no dependency metadata, so analyze fails at import.

The two modes want different environments:

mode	install	analyze deps
profile	`pip install rocm rocm-profiler torch`	none, workload environment untouched
analyze	`pip install --extra-index-url <rocm_index> rocm-profiler[compute-analyze]`	full stack, no torch to conflict with

Under that split the deps belong in an extra, and exact pins remain appropriate because the analyze venv is isolated.

Related Issues

ISSUE ID: #7003

JIRA ID: AIPROFCOMP-788

Technical Details

Deps are read at build time from the staged payload at libexec/rocprofiler-compute/requirements.txt, which PROFILER_WHEEL_INCLUDES already carries into the wheel. rocprofiler-compute stays the single source of truth, so pin changes need no change here.
populate_runtime_files() stages that payload before build_packages() invokes setup.py, so the file is on disk when read. setup.py already loads _dist_info.py off disk the same way.
The extra is declared even when the payload lacks the file, so pip install rocm-profiler[compute-analyze] resolves against any build rather than warning about an unknown extra.
The analyze venv installs with --extra-index-url <rocm_index>, so the extra's deps come from PyPI and rocm-profiler comes from the ROCm index.
Named per tool, not per mode: this wheel also carries rocprofiler-systems, so a bare analyze gets ambiguous once anything else here needs Python packages. A second tool should get its own extra reading its own requirements file, not a merged list, which would force both tools' pins to relax.
rocm[profiler] does not chain into the extra, by design. Analyze deps stay opt-in.

Test Plan

Staged the profiler package with PopulatedDistPackage, built the wheel through TheRock's own build_packages(), then read METADATA and ran pip install --dry-run in a clean venv.

Test Result

Every dep from the staged requirements.txt is gated behind the extra, with comment lines dropped. A plain install pulls no analyze deps; [compute-analyze] pulls the full set. A payload staged without requirements.txt builds cleanly with the extra declared and empty.

Submission Checklist

Look over the contributing guidelines at https://github.com/ROCm/TheRock/blob/main/CONTRIBUTING.md.

🤖 Generated with Claude Code

therock-pr-bot · 2026-07-30T18:48:12Z

✅ All Checks Passed — Ready for Review

Check	Status	Details
📝 PR Description	✅ Pass	—
⛔ Forbidden Files	✅ Pass	—
🧪 Unit Test	✅ Pass	—
🔎 pre-commit	✅ Pass	—
🚫 Draft PR	🔜 To Be Enabled	—
🚩 Feature Flag	🔜 To Be Enabled	—
📊 Code Coverage	🔜 To Be Enabled	—
🤖 therock-pr-bot	✅ Pass	—

🎉 All checks passed! This PR is ready for review.

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

therock-pr-bot · 2026-07-30T18:48:14Z

🎉 All checks passed! This PR is ready for review.

Copilot

Pull request overview

This PR updates the rocm-profiler wheel template so it declares runtime dependencies needed by rocprof-compute analyze, by reading them from the staged rocprofiler-compute payload during wheel build. This aligns the advertised install path (pip install rocm[profiler]) with actual runtime requirements.

Changes:

Add build-time parsing of libexec/rocprofiler-compute/requirements.txt from the staged wheel payload and pass it via install_requires.
Document the new dependency sourcing behavior in the template README.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
build_tools/packaging/python/templates/rocm-profiler/setup.py	Reads `rocprofiler-compute`’s staged `requirements.txt` and wires it into `install_requires` for the `rocm-profiler` wheel.
build_tools/packaging/python/templates/rocm-profiler/README.md	Updates packaging notes to reflect that dependencies are sourced from the staged payload file.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

jbonnell-amd

Assuming we are good with adding all of requirements.txt dependencies into the rocm-profiler install, should we also do a follow-up PR to add in requirements for sdk and systems as well? We would also need to eliminate duplicates and ensure version requirements do not mismatch, but this would resolve any other potential dependency issues we'd have.

vedithal-amd · 2026-07-31T02:27:12Z

Assuming we are good with adding all of requirements.txt dependencies into the rocm-profiler install, should we also do a follow-up PR to add in requirements for sdk and systems as well? We would also need to eliminate duplicates and ensure version requirements do not mismatch, but this would resolve any other potential dependency issues we'd have.

@jbonnell-amd I dont think systems has any requirements.txt python deps and sdk is not part of rocm-profiler package

vedithal-amd · 2026-08-01T02:34:31Z

@jbonnell-amd per my comment in ROCM-28653 we should not merge this PR since compute's python dependencies will clash with those of torch and the python application being profiled.

Folks would be better of creating a virtual environment for analysis mode based of our requirements.txt and a message in analysis mode instructing users to do so along with the path to requirements.txt should be enough

marbre · 2026-08-03T10:17:27Z

@jbonnell-amd per my comment in ROCM-28653 we should not merge this PR since compute's python dependencies will clash with those of torch and the python application being profiled.

Folks would be better of creating a virtual environment for analysis mode based of our requirements.txt and a message in analysis mode instructing users to do so along with the path to requirements.txt should be enough

If you don't want to merge this, maybe close or move to draft?

vedithal-amd · 2026-08-04T17:41:05Z

@jbonnell-amd per my comment in ROCM-28653 we should not merge this PR since compute's python dependencies will clash with those of torch and the python application being profiled.
Folks would be better of creating a virtual environment for analysis mode based of our requirements.txt and a message in analysis mode instructing users to do so along with the path to requirements.txt should be enough

If you don't want to merge this, maybe close or move to draft?

I think we can still merge this PR if we don't use install_requires but instead add a rocm-profiler[compute-analyze] extra which pull in compute's analyze deps. This way we can provide a way for users to setup a venv for analyze only.

I have implemented this change.

marbre · 2026-08-27T07:00:41Z

@jbonnell-amd per my comment in ROCM-28653 we should not merge this PR since compute's python dependencies will clash with those of torch and the python application being profiled.
Folks would be better of creating a virtual environment for analysis mode based of our requirements.txt and a message in analysis mode instructing users to do so along with the path to requirements.txt should be enough

If you don't want to merge this, maybe close or move to draft?

I think we can still merge this PR if we don't use install_requires but instead add a rocm-profiler[compute-analyze] extra which pull in compute's analyze deps. This way we can provide a way for users to setup a venv for analyze only.

I have implemented this change.

@jbonnell-amd @vedithal-amd how do you want to proceed here?

vedithal-amd · 2026-08-27T14:12:14Z

@jbonnell-amd per my comment in ROCM-28653 we should not merge this PR since compute's python dependencies will clash with those of torch and the python application being profiled.
Folks would be better of creating a virtual environment for analysis mode based of our requirements.txt and a message in analysis mode instructing users to do so along with the path to requirements.txt should be enough

If you don't want to merge this, maybe close or move to draft?

I think we can still merge this PR if we don't use install_requires but instead add a rocm-profiler[compute-analyze] extra which pull in compute's analyze deps. This way we can provide a way for users to setup a venv for analyze only.
I have implemented this change.

@jbonnell-amd @vedithal-amd how do you want to proceed here?

Bit busy with other priority items, will circle back here.

But high level - we really need compute-analyze extra in pip install rocm-profiler - so this pr is important and should not be closed

Basically, folks need an easy way to create python venv with compute analyze deps pulled in instead of running pip install /path/to/requirements

vedithal-amd · 2026-09-16T20:10:51Z

Hi @ScottTodd and @marbre could you please review this PR.

The idea is to support pip install --extra-index-url <rocm_index> rocm-profiler[compute-analyze] which forwards the transitive closure of 44 python dependencies (and growing) defined in https://github.com/ROCm/rocm-systems/blob/develop/projects/rocprofiler-compute/requirements.txt - rocprofiler-compute documentation and runtime output will instruct folks to create a separate venv and run this command so that they have everything they need for rocprofiler-compute analyze mode.

Note that rocprofiler-compute profile mode requires no python dependencies, so it plays well with workload to be profiled.

However, rocprofiler-compute analyze wants its own venv to get the plethora of dependencies without disturbing their ROCm environment.

Currently, folks need to run pip install -r /path/to/rocprofiler-compute/requirements.txt to get the python dependencies for analysis. However, with this PR that step is no longer needed. It's expected that these dependencies have to come from PyPI not ROCm index hence --extra-index

The rocm-profiler wheel shipped no dependency metadata, so `rocprof-compute analyze` failed at import with dash, pandas and numpy missing. Declaring them as install_requires would fix analyze at the cost of profile mode: this wheel installs into the environment being profiled, and compute's requirements.txt pins exact versions (numpy==1.26.4, pandas==2.2.3) that fight torch there. Analyze is meant to run from its own venv, so the deps go under an extra and the pins stay appropriate. The list is read from the staged rocprofiler-compute payload's requirements.txt, keeping rocprofiler-compute the single source of truth. The extra is named for the tool, not the mode, because this wheel carries rocprofiler-systems too. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

ScottTodd

Thanks, this looks good to me now.

I checked the generated whl from the CI build:

Here's the metadata:

Metadata-Version: 2.4
Name: rocm-profiler
Version: 10.2.0.dev0+6ee43d2fadf65113c3c23212e823c93b6b953281
Summary: ROCm profiler applications (rocprofiler-systems and rocprofiler-compute)
Requires-Python: >=3.8
Provides-Extra: compute-analyze
Requires-Dist: astunparse==1.6.2; extra == "compute-analyze"
Requires-Dist: dash-bootstrap-components==2.0.4; extra == "compute-analyze"
Requires-Dist: dash-svg==0.0.12; extra == "compute-analyze"
Requires-Dist: dash==3.4.0; extra == "compute-analyze"
Requires-Dist: numpy==1.26.4; python_version < "3.13" and extra == "compute-analyze"
Requires-Dist: numpy==2.5.2; python_version >= "3.13" and extra == "compute-analyze"
Requires-Dist: pandas==2.2.3; extra == "compute-analyze"
Requires-Dist: plotext==5.3.2; extra == "compute-analyze"
Requires-Dist: plotille==5.0.0; extra == "compute-analyze"
Requires-Dist: pyyaml==6.0.3; extra == "compute-analyze"
Requires-Dist: sqlalchemy==2.0.46; extra == "compute-analyze"
Requires-Dist: tabulate==0.9.0; extra == "compute-analyze"
Requires-Dist: textual==7.3.0; extra == "compute-analyze"
Requires-Dist: textual_plotext==1.0.1; extra == "compute-analyze"
Dynamic: provides-extra
Dynamic: requires-python
Dynamic: summary

Install rocm-profiler[compute-analyze] into its own venv in the wheel test workflow and run `rocprof-compute analyze --help`, which imports the whole extra and so fails if a dependency is missing. Add --extra-index-url to setup_venv.py for this: the extra's dependencies come from PyPI, which --index-url alone replaces. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

vedithal-amd · 2026-09-18T19:18:47Z

Pushed the CI coverage for the extra. The new steps are in the Test ROCm wheels jobs on Linux, after Test rocm[profiler]:

Install rocm-profiler[compute-analyze]
Show installed packages (compute-analyze)
Test rocprof-compute analyze

Worth confirming these are green before merge. The install step resolves the analyze pins from PyPI, so a failure there is dependency resolution rather than anything wrong with the wheel.

CI passes an empty --index-url and installs from --find-links, which meant the compute-analyze step asked for no index and an extra index at once. Promote the extra to the index in that case instead of failing. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

vedithal-amd · 2026-09-21T13:18:08Z

Seems like the compute-analyze extra pip install wheel tests have passed - see https://github.com/ROCm/TheRock/actions/runs/35400766420/job/105797810618?pr=7002

Merging this PR

…ute-analyze extra (#11928) ## Motivation Analyze mode needs Python packages that profile mode does not. There was no way to check whether an environment had them without also having a workload to analyze, because the existing check only ran on the way into an analysis. The failure message also pointed at the requirements file, which lists the pins but not how to install them. ### Validated using latest nightly ``` python3 -m venv ~/.venvs/rocprof-compute-analyze source ~/.venvs/rocprof-compute-analyze/bin/activate pip install --extra-index-url https://nightly.repo.amd.com/rocm/whl-next/ "rocm-profiler[compute-analyze]==10.2.0a20260922" ``` The rocprof-compute along with its python dependencies are installed in the venv - so no more manually pip installing the requirements.txt ## Technical Details - `rocprof-compute analyze --verify-deps` runs the existing `verify_deps()` check and exits: zero when every pin is installed at the required version, non-zero otherwise. `-p` stays optional, so the flag works as a standalone environment check. - The failure message now points at the install docs, following the doc-link constant style already used in `utils_profile.py` and `profiler_base.py`. - Docs gain an `analyze-deps` section in `core-install.rst` covering both install paths: the `rocm-profiler[compute-analyze]` extra for pip users and the requirements file for packaged ROCm installations. The quickstart step links there instead of repeating it, matching how that page already defers to `core-install` for detail. - The extra is new in TheRock (ROCm/TheRock#7002), which is what makes the pip path documentable. ## Issue Tracking JIRA ID: AIPROFCOMP-788 ## Test Plan Ran `analyze --verify-deps` from the source tree in two environments: one with the requirements installed and one bare virtual environment. Added unit tests for the flag's default and for it parsing without `-p`, then ran the argparser suite and ruff. ## Test Result With the dependencies present the flag reports success and exits zero. In the bare environment it lists each missing package, prints the docs link, and exits one. The argparser unit tests pass and ruff is clean. ## Submission Checklist - [ ] Look over the contributing guidelines at https://github.com/ROCm/rocm-systems/blob/develop/CONTRIBUTING.md. --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>

## Motivation * Progress on #8272 * Follow-up to #7828 * Follow-up to #8275 * Follow-up to #7002 See https://docs.zizmor.sh/audits/#template-injection and https://github.com/ROCm/TheRock/blob/main/docs/development/style_guides/github_actions_style_guide.md#security---avoid-template-injection. ## Test Plan * `.github/workflows/test_code_coverage_component.yml` untested. * `.github/workflows/test_rocm_wheels.yml` will run on CI. ## Submission Checklist - [x] Look over the contributing guidelines at https://github.com/ROCm/TheRock/blob/main/CONTRIBUTING.md.

vedithal-amd requested review from ScottTodd and marbre as code owners July 30, 2026 18:47

Copilot AI review requested due to automatic review settings July 30, 2026 18:47

github-project-automation Bot added this to TheRock Triage Jul 30, 2026

github-project-automation Bot moved this to TODO in TheRock Triage Jul 30, 2026

therock-pr-bot Bot added the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 30, 2026

Copilot started reviewing on behalf of vedithal-amd July 30, 2026 18:48

View session

vedithal-amd changed the title ~~Declare rocprof-compute's analyze dependencies in the rocm-profiler wheel~~ fix(rocprofiler-compute): Declare rocprof-compute analyze dependencies in the rocm-profiler wheel Jul 30, 2026

Copilot AI reviewed Jul 30, 2026

View reviewed changes

therock-pr-bot Bot removed the Not ready to Review PR has unresolved policy failures — reviews blocked label Jul 30, 2026

vedithal-amd force-pushed the users/vedithal-amd/rocm-profiler-compute-deps branch from f220f23 to fbf56f8 Compare July 30, 2026 19:10

jbonnell-amd reviewed Jul 30, 2026

View reviewed changes

ScottTodd reviewed Aug 3, 2026

View reviewed changes

Comment thread build_tools/packaging/python/templates/rocm-profiler/setup.py Resolved

vedithal-amd force-pushed the users/vedithal-amd/rocm-profiler-compute-deps branch from fbf56f8 to 17d51db Compare August 4, 2026 15:52

vedithal-amd changed the title ~~fix(rocprofiler-compute): Declare rocprof-compute analyze dependencies in the rocm-profiler wheel~~ fix(rocprofiler-compute): Add rocm-profiler[compute-analyze] extra for rocprof-compute analyze deps Aug 4, 2026

vedithal-amd changed the title ~~fix(rocprofiler-compute): Add rocm-profiler[compute-analyze] extra for rocprof-compute analyze deps~~ fix(rocprofiler-compute): Gate rocprof-compute analyze deps behind an opt-in compute-analyze extra Aug 4, 2026

vedithal-amd force-pushed the users/vedithal-amd/rocm-profiler-compute-deps branch from 17d51db to 1021a68 Compare August 4, 2026 17:34

vedithal-amd mentioned this pull request Aug 4, 2026

rocprof-compute analyze fails at import: no installable dependency set #7003

Open

vedithal-amd force-pushed the users/vedithal-amd/rocm-profiler-compute-deps branch from 1021a68 to 844a6c1 Compare September 16, 2026 18:48

vedithal-amd force-pushed the users/vedithal-amd/rocm-profiler-compute-deps branch from 844a6c1 to e5f6eb7 Compare September 16, 2026 20:14

ScottTodd self-requested a review September 16, 2026 20:15

ScottTodd approved these changes Sep 17, 2026

View reviewed changes

Comment thread build_tools/packaging/python/templates/rocm-profiler/setup.py Resolved

marbre reviewed Sep 17, 2026

View reviewed changes

Comment thread build_tools/packaging/python/templates/rocm-profiler/README.md Resolved

vedithal-amd merged commit e8268e6 into main Sep 21, 2026
186 of 192 checks passed

vedithal-amd deleted the users/vedithal-amd/rocm-profiler-compute-deps branch September 21, 2026 13:18

github-project-automation Bot moved this from TODO to Done in TheRock Triage Sep 21, 2026

vedithal-amd mentioned this pull request Sep 21, 2026

docs(rocprofiler-compute): install analyze dependencies with the compute-analyze extra ROCm/rocm-systems#11928

Merged

1 task

ScottTodd mentioned this pull request Oct 1, 2026

[security] Fix template injection in component and wheel tests #8680

Merged

1 task done

This was referenced Nov 3, 2026

Fix ROCpd dependencies in Python wheels #9535

Open

Define ROCm-index-only installation for ROCpd Python extras #9788

Open

Conversation

vedithal-amd commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Related Issues

Technical Details

Test Plan

Test Result

Submission Checklist

Uh oh!

therock-pr-bot Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ All Checks Passed — Ready for Review

Uh oh!

therock-pr-bot Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

jbonnell-amd left a comment

Choose a reason for hiding this comment

Uh oh!

vedithal-amd commented Jul 31, 2026

Uh oh!

vedithal-amd commented Aug 1, 2026

Uh oh!

marbre commented Aug 3, 2026

Uh oh!

Uh oh!

vedithal-amd commented Aug 4, 2026

Uh oh!

marbre commented Aug 27, 2026

Uh oh!

vedithal-amd commented Aug 27, 2026

Uh oh!

vedithal-amd commented Sep 16, 2026

Uh oh!

ScottTodd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vedithal-amd commented Sep 18, 2026

Uh oh!

vedithal-amd commented Sep 21, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vedithal-amd commented Jul 30, 2026 •

edited

Loading

therock-pr-bot Bot commented Jul 30, 2026 •

edited

Loading

therock-pr-bot Bot commented Jul 30, 2026 •

edited

Loading