[rocprofiler-sdk] Updating documentation for --selected-regions#3327
Open
[rocprofiler-sdk] Updating documentation for --selected-regions#3327
Conversation
github-actions
bot
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for the --selected-regions option in rocprofv3, explaining how it works with the roctxProfilerPause() and roctxProfilerResume() APIs to enable fine-grained profiling control. The PR also updates the help text to clarify that --selected-regions requires --marker-trace to function properly.
Changes:
- Added extensive documentation explaining two modes of operation for profiler control: default behavior (profile everything except marked regions) and selected-regions mode (profile only marked regions)
- Updated the
--selected-regionshelp text to explicitly state it needs to be combined with--marker-trace - Included code examples demonstrating thread-specific control and multi-region profiling patterns
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst | Added 150+ lines of comprehensive documentation covering the two operational modes, usage examples, thread-specific control, compatibility with other options, and a comparison table |
| projects/rocprofiler-sdk/source/bin/rocprofv3.py | Updated help text to clarify that --selected-regions requires --marker-trace |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Outdated
Show resolved
Hide resolved
gsitaram
reviewed
Feb 18, 2026
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Show resolved
Hide resolved
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Show resolved
Hide resolved
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Outdated
Show resolved
Hide resolved
Contributor
Author
bgopesh
force-pushed
the
users/bgopesh/use_of_selected_regions
branch
from
5288c4b to
1381b38
Compare
jrmadsen
changed the title
4 tasks
bgopesh
force-pushed
the
users/bgopesh/use_of_selected_regions
branch
5 times, most recently
from
860cc61 to
480684d
Compare
bgopesh
force-pushed
the
users/bgopesh/use_of_selected_regions
branch
2 times, most recently
from
879f8d8 to
d032cd9
Compare
Contributor
Author
|
@itrowbri please review, so I can merge this soon. |
bgopesh
force-pushed
the
users/bgopesh/use_of_selected_regions
branch
from
d032cd9 to
80f16b2
Compare
bgopesh
force-pushed
the
users/bgopesh/use_of_selected_regions
branch
from
80f16b2 to
fa48c71
Compare
gsitaram
requested changes
Mar 31, 2026
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Outdated
Show resolved
Hide resolved
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Outdated
Show resolved
Hide resolved
bgopesh
force-pushed
the
users/bgopesh/use_of_selected_regions
branch
from
fa48c71 to
3873b46
Compare
gsitaram
approved these changes
Mar 31, 2026
gsitaram
left a comment
gsitaram
left a comment
There was a problem hiding this comment.
LGTM with one change that I recommend.
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Outdated
Show resolved
Hide resolved
bgopesh
force-pushed
the
users/bgopesh/use_of_selected_regions
branch
from
6a2fe81 to
f4e8171
Compare
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Outdated
Show resolved
Hide resolved
srihari-uttanur
approved these changes
Apr 1, 2026
Contributor
srihari-uttanur
left a comment
srihari-uttanur
left a comment
There was a problem hiding this comment.
just a few minor questions and suggestions.
…sdk-roctx.rst Co-authored-by: Srihari Uttanur <srihari.u@amd.com>
bgopesh
force-pushed
the
users/bgopesh/use_of_selected_regions
branch
from
24052ec to
1671fe6
Compare
subbul-amd
reviewed
Apr 1, 2026
projects/rocprofiler-sdk/source/docs/how-to/using-rocprofiler-sdk-roctx.rst
Show resolved
Hide resolved
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.
Motivation
https://amd-hub.atlassian.net/browse/AIPROFSDK-55
https://amd-hub.atlassian.net/browse/AIPROFSDK-148
Technical Details
JIRA ID
https://amd-hub.atlassian.net/browse/AIPROFSDK-55
Test Plan
Test Result
Submission Checklist