[rocprof-compute] Add Experimental Option #3143
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an --experimental switch to rocprof-compute to gate access to work-in-progress CLI options (e.g., spatial multiplexing), keeping them hidden by default while allowing opt-in usage.
Changes:
- Introduces an experimental feature registry (
EXPERIMENTAL_FEATURES) and a new--experimentalCLI option. - Gates experimental CLI flags behind
--experimentaland optionally expands help output when--experimental --helpis requested. - Adds early argv scanning to detect attempted use of experimental flags without opting in.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| projects/rocprofiler-compute/src/rocprof_compute_base.py | Pre-scans argv for experimental usage, enforces opt-in, and passes experimental gating flags into the arg parser. |
| projects/rocprofiler-compute/src/argparser.py | Adds --experimental, defines the experimental feature registry, and conditionally registers experimental CLI options. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -192,7 +220,12 @@ def parse_args(self) -> None: | |||
| usage="rocprof-compute [mode] [options]", | |||
| ) | |||
| omniarg_parser( | |||
| parser, config.rocprof_compute_home, self.__supported_archs, self.__version | |||
| parser, | |||
| config.rocprof_compute_home, | |||
| self.__supported_archs, | |||
| self.__version, | |||
| experimental_enabled=experimental_requested, | |||
| show_experimental_help=show_experimental_help, | |||
| ) | |||
There was a problem hiding this comment.
Add coverage for the new experimental gating behavior (e.g., --spatial-multiplexing without --experimental should exit with an error; --experimental --help should show the experimental feature list; normal invocations without any experimental flags should not crash). This prevents regressions in CLI parsing behavior.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 participant
Motivation
rocprof-compute may contain feature(s) containing multiple development stages, and these features' subcomponents are released on a rolling basis. Adding the option
--experimentalallows interested users to use the work-in-progress features that are by default hidden.Technical Details
Adds an
--experimentalswitch to gate access to work-in-progress CLI options (e.g., spatial multiplexing), keeping them hidden by default while allowing opt-in usage.Changes:
Introduces an experimental feature registry (
EXPERIMENTAL_FEATURES) insrc/argparser.pyand a new--experimentalCLI option.Gates experimental CLI flags behind
--experimentaland expands help output.Adds early argv scanning to detect attempted use of experimental flags without opting in.
JIRA ID
AIPROFCOMP-186
Test Plan
Add unit tests
Add to ctest
Local pass (mi325x)
Test Result
Submission Checklist