refactor(rocprofiler-compute): Extract shared HTML report shell by abchoudh-amd · Pull Request #12529 · ROCm/rocm-systems

abchoudh-amd · 2026-09-30T13:48:18Z

Motivation

The memory chart HTML work needs a shared report frame. This refactor moves the existing roofline page onto that frame while keeping its model and controls.

Technical Details

Move document assembly, asset loading, and script-safe JSON embedding into shared HTML report utilities.
Keep the roofline plot fragment and page assets while the shared shell supplies the document frame and theme setup.
Register shared-shell unit coverage alongside the existing roofline tests.

JIRA ID

JIRA ID: AIPROFCOMP-868

Test Plan

Run ctest for the roofline main, roofline analyze, and HTML report targets.

Test Result

ctest for the roofline main, roofline analyze, and HTML report targets pass

Submission Checklist

Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests.

Copilot

Copilot review overview

🟡 Changes recommended

JSON embedding remains vulnerable to script parser state changes, and NumPy booleans cannot be serialized.

Review effort: Balanced
Findings: 1 · 1

Open (2)

Escape all less-than characters in JSON embedded in scripts · New
Normalize NumPy boolean scalars for JSON serialization · New

What changed in this PR

Extracts a reusable standalone HTML report shell and migrates the roofline report to it.

Changes:

Adds shared document, asset, JSON, model, and theme utilities.
Refactors roofline HTML generation to use the shared shell.
Adds unit tests and registers them with CTest categories.

File	Description
`CMakeLists.txt`	Registers shared-shell tests.
`src/utils/html_report/__init__.py`	Defines the utility package.
`src/utils/html_report/document.py`	Implements shared document assembly.
`src/utils/html_report/assets/report_shell.html`	Provides the common HTML frame.
`src/utils/html_report/assets/report_base.js`	Provides shared model and theme handling.
`src/roofline/roofline_html.py`	Migrates roofline document generation.
`src/roofline/assets/roofline_plot.html`	Reduces the template to body content.
`src/roofline/assets/roofline_plot.js`	Uses shared model and theme APIs.
`src/roofline/assets/roofline_plot.css`	Adopts the shared theme class.
`tests/unit/utils/test_html_report.py`	Tests shared report utilities.
`tests/unit/roofline/test_roofline_main.py`	Updates roofline integration tests.
`tests/test_categories.yaml`	Adds the new test to test tiers.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

- Remove the model id check; every caller passes a hard-coded id. - Test shell behavior (title escaping, fragment order, dark theme, JSON escaping) instead of exact template text. - Remove the Plotly bundle and missing-file tests. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

vedithal-amd · 2026-10-19T18:32:31Z

Pushed a small follow-up: removed the model id check (callers pass hard-coded ids), trimmed the shell tests to behavior instead of exact template text, and dropped the Plotly bundle and missing-file tests.

vedithal-amd

LGTM

- Route the roofline kernel list tooltip assets from #12190 through build_document. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

## Motivation The memory chart HTML work in [AIPROFCOMP-868](https://amd-hub.atlassian.net/browse/AIPROFCOMP-868) needs report controls and panels that can be styled consistently. This refactor builds on #12529 and keeps the roofline page appearance. ## Technical Details - Move common report layout, panel, control, and theme styles into a shared base stylesheet. - Rename the generic roofline CSS classes and variables to report names while keeping roofline-only rules local. - Keep roofline element IDs and controls compatible with its existing JavaScript and tests. ## JIRA ID JIRA ID: AIPROFCOMP-868 ## Test Plan - [x] Run ctest for the roofline main, roofline analyze, and HTML report targets. - [x] Run workload: Open a generated two-kernel roofline page offline and verify theme, selection, Ctrl-click, Show all, and PNG export. ## Test Result - [x] ctest for the roofline main, roofline analyze, and HTML report targets pass ## Submission Checklist - [x] Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests. [AIPROFCOMP-868]: https://amd-hub.atlassian.net/browse/AIPROFCOMP-868?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Vignesh Edithal <Vignesh.Edithal@amd.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

The memory chart HTML work needs a shared report frame. This refactor moves the existing roofline page onto that frame while keeping its model and controls. - Move document assembly, asset loading, and script-safe JSON embedding into shared HTML report utilities. - Keep the roofline plot fragment and page assets while the shared shell supplies the document frame and theme setup. - Register shared-shell unit coverage alongside the existing roofline tests. JIRA ID: AIPROFCOMP-868 - [x] Run ctest for the roofline main, roofline analyze, and HTML report targets. - [X] ctest for the roofline main, roofline analyze, and HTML report targets pass - [x] Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests. [AIPROFCOMP-868]: https://amd-hub.atlassian.net/browse/AIPROFCOMP-868?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Vignesh Edithal <Vignesh.Edithal@amd.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

## Motivation The memory chart HTML work in [AIPROFCOMP-868](https://amd-hub.atlassian.net/browse/AIPROFCOMP-868) needs report controls and panels that can be styled consistently. This refactor builds on #12529 and keeps the roofline page appearance. ## Technical Details - Move common report layout, panel, control, and theme styles into a shared base stylesheet. - Rename the generic roofline CSS classes and variables to report names while keeping roofline-only rules local. - Keep roofline element IDs and controls compatible with its existing JavaScript and tests. ## JIRA ID JIRA ID: AIPROFCOMP-868 ## Test Plan - [x] Run ctest for the roofline main, roofline analyze, and HTML report targets. - [x] Run workload: Open a generated two-kernel roofline page offline and verify theme, selection, Ctrl-click, Show all, and PNG export. ## Test Result - [x] ctest for the roofline main, roofline analyze, and HTML report targets pass ## Submission Checklist - [x] Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests. [AIPROFCOMP-868]: https://amd-hub.atlassian.net/browse/AIPROFCOMP-868?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Vignesh Edithal <Vignesh.Edithal@amd.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

The memory chart HTML work needs a shared report frame. This refactor moves the existing roofline page onto that frame while keeping its model and controls. - Move document assembly, asset loading, and script-safe JSON embedding into shared HTML report utilities. - Keep the roofline plot fragment and page assets while the shared shell supplies the document frame and theme setup. - Register shared-shell unit coverage alongside the existing roofline tests. JIRA ID: AIPROFCOMP-868 - [x] Run ctest for the roofline main, roofline analyze, and HTML report targets. - [X] ctest for the roofline main, roofline analyze, and HTML report targets pass - [x] Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests. [AIPROFCOMP-868]: https://amd-hub.atlassian.net/browse/AIPROFCOMP-868?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Vignesh Edithal <Vignesh.Edithal@amd.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

## Motivation The memory chart HTML work in [AIPROFCOMP-868](https://amd-hub.atlassian.net/browse/AIPROFCOMP-868) needs report controls and panels that can be styled consistently. This refactor builds on #12529 and keeps the roofline page appearance. ## Technical Details - Move common report layout, panel, control, and theme styles into a shared base stylesheet. - Rename the generic roofline CSS classes and variables to report names while keeping roofline-only rules local. - Keep roofline element IDs and controls compatible with its existing JavaScript and tests. ## JIRA ID JIRA ID: AIPROFCOMP-868 ## Test Plan - [x] Run ctest for the roofline main, roofline analyze, and HTML report targets. - [x] Run workload: Open a generated two-kernel roofline page offline and verify theme, selection, Ctrl-click, Show all, and PNG export. ## Test Result - [x] ctest for the roofline main, roofline analyze, and HTML report targets pass ## Submission Checklist - [x] Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests. [AIPROFCOMP-868]: https://amd-hub.atlassian.net/browse/AIPROFCOMP-868?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Vignesh Edithal <Vignesh.Edithal@amd.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

The memory chart HTML work needs a shared report frame. This refactor moves the existing roofline page onto that frame while keeping its model and controls. - Move document assembly, asset loading, and script-safe JSON embedding into shared HTML report utilities. - Keep the roofline plot fragment and page assets while the shared shell supplies the document frame and theme setup. - Register shared-shell unit coverage alongside the existing roofline tests. JIRA ID: AIPROFCOMP-868 - [x] Run ctest for the roofline main, roofline analyze, and HTML report targets. - [X] ctest for the roofline main, roofline analyze, and HTML report targets pass - [x] Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests. [AIPROFCOMP-868]: https://amd-hub.atlassian.net/browse/AIPROFCOMP-868?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Vignesh Edithal <Vignesh.Edithal@amd.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

## Motivation The memory chart HTML work in [AIPROFCOMP-868](https://amd-hub.atlassian.net/browse/AIPROFCOMP-868) needs report controls and panels that can be styled consistently. This refactor builds on #12529 and keeps the roofline page appearance. ## Technical Details - Move common report layout, panel, control, and theme styles into a shared base stylesheet. - Rename the generic roofline CSS classes and variables to report names while keeping roofline-only rules local. - Keep roofline element IDs and controls compatible with its existing JavaScript and tests. ## JIRA ID JIRA ID: AIPROFCOMP-868 ## Test Plan - [x] Run ctest for the roofline main, roofline analyze, and HTML report targets. - [x] Run workload: Open a generated two-kernel roofline page offline and verify theme, selection, Ctrl-click, Show all, and PNG export. ## Test Result - [x] ctest for the roofline main, roofline analyze, and HTML report targets pass ## Submission Checklist - [x] Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests. [AIPROFCOMP-868]: https://amd-hub.atlassian.net/browse/AIPROFCOMP-868?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Vignesh Edithal <Vignesh.Edithal@amd.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

first commit

30a7f6a

github-actions Bot added the project: rocprofiler-compute label Sep 30, 2026

abchoudh-amd mentioned this pull request Sep 30, 2026

refactor(rocprofiler-compute): Share report base styles #12530

Merged

4 tasks done

abchoudh-amd added this pull request to stack #12533 September 30, 2026 13:50

systems-assistant Bot added the organization: ROCm label Sep 30, 2026

fix embeding and tests

34a7585

abchoudh-amd marked this pull request as ready for review October 1, 2026 10:36

Copilot AI balanced review requested due to automatic review settings October 1, 2026 10:36

abchoudh-amd requested a review from a team as a code owner October 1, 2026 10:36

Copilot started reviewing on behalf of abchoudh-amd October 1, 2026 10:37

View session

Copilot AI reviewed Oct 1, 2026

View reviewed changes

Comment thread projects/rocprofiler-compute/src/utils/html_report/document.py Resolved

Comment thread projects/rocprofiler-compute/src/utils/html_report/document.py Resolved

abchoudh-amd removed this pull request from stack #12533 October 5, 2026 04:51

abchoudh-amd added this pull request to stack #12775 October 5, 2026 04:51

cfallows-amd reviewed Oct 14, 2026

View reviewed changes

Comment thread projects/rocprofiler-compute/tests/unit/utils/test_report_shell.py Resolved

Comment thread projects/rocprofiler-compute/src/utils/html_report/report_shell.py Resolved

Comment thread projects/rocprofiler-compute/tests/unit/roofline/test_roofline_main.py Resolved

vedithal-amd requested changes Oct 15, 2026

View reviewed changes

Addressed PR comments

4a8dea7

abchoudh-amd requested review from cfallows-amd and vedithal-amd October 16, 2026 12:46

vedithal-amd approved these changes Oct 19, 2026

View reviewed changes

Merge rocprofiler-compute-develop into 1-html-report-shell

05f7bff

- Route the roofline kernel list tooltip assets from #12190 through build_document. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

vedithal-amd merged commit c7d8b5f into rocprofiler-compute-develop Oct 19, 2026
76 checks passed

vedithal-amd deleted the users/abchoudh/aiprofcomp-868/1-html-report-shell branch October 19, 2026 22:09

Navigation Menu

Repository navigation

refactor(rocprofiler-compute): Extract shared HTML report shell - #12529

refactor(rocprofiler-compute): Extract shared HTML report shell#12529
vedithal-amd merged 5 commits into
rocprofiler-compute-developfrom
users/abchoudh/aiprofcomp-868/1-html-report-shell

abchoudh-amd commented Sep 30, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vedithal-amd commented Oct 19, 2026

Uh oh!

vedithal-amd left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

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

Uh oh!

Motivation

Technical Details

JIRA ID

Test Plan

Test Result

Submission Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vedithal-amd commented Oct 19, 2026

Uh oh!

vedithal-amd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

abchoudh-amd commented Sep 30, 2026 •

edited

Loading