Skip to content

docs(sparse): add testing.md for rocSPARSE, hipSPARSE, and rocALUTION - #11944

Merged
kliegeois merged 16 commits into
developfrom
users/kliegeois/testing-md-initiative
Sep 23, 2026
Merged

docs(sparse): add testing.md for rocSPARSE, hipSPARSE, and rocALUTION#11944
kliegeois merged 16 commits into
developfrom
users/kliegeois/testing-md-initiative

Conversation

@kliegeois

@kliegeois kliegeois commented Sep 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

JIRA ID: AISPARSE-761

Summary

  • Add current-state testing.md for rocSPARSE, hipSPARSE, and rocALUTION (how the suites are structured, what actually gates a merge, and known gaps).
  • Document the rocSPARSE clients/unittests/ layer now on develop (rocsparse-unit-test / rocsparse-unit-test-device), including that TheRock standard still only runs rocsparse-test.
  • Align hipSPARSE merge-gate wording with TheRock and keep hipSPARSE/rocALUTION from implying a rocSPARSE-style unit-test binary.

Test plan

  • Read the three files as a developer: can you build, pick the right binary, and tell what CI will run?
  • Confirm rocSPARSE unit-test commands (ctest -R '^rocsparse-unit-test$' vs device binary) and the TheRock vs Jenkins distinction.
  • Confirm hipSPARSE does not claim a clients/unittests/ layer; CUDA lane is informational Jenkins, not TheRock.
  • Confirm rocALUTION env-var tiers and the note that Jenkins *checkin*/*nightly* filters match no current names.
  • Doc-only paths (*.md) skip TheRock CI by design.

Made with Cursor

kliegeois and others added 15 commits August 6, 2026 20:53
@kliegeois
draft of the TESTING.md files for the rocsparse team
8797d09
@kliegeois
Fixes
6c1dfc6
@kliegeois
Fixes
692630f
@kliegeois
wip
8f608da
@kliegeois
wip
f94d105
@kliegeois
wip
7d040bf
@jsandham
Fix install steps
b2e4ce2
@jsandham
Fixing incorrect information in testing.md
d259fa6
@jsandham
Fixing incorrect information in testing.md
e02f0c5
@kliegeois
Merge remote-tracking branch 'upstream/develop' into users/kliegeois/…
920a898 
…testing-md-initiative
@kliegeois
wip
45b8eb6
@jsandham
Add test time guidelines to testing.md files for rocsparse and hipsparse
bc6910a
@jsandham
Merge branch 'users/kliegeois/testing-md-initiative' of github.com:RO…
4540230 
…Cm/rocm-libraries into users/kliegeois/testing-md-initiative
@kliegeois @cursoragent
Document rocSPARSE unit tests as landed on develop.
6bb06f3 
Rewrite the WIP unit-test section to match clients/unittests/, correct TheRock vs Jenkins gating, and note that hipSPARSE/rocALUTION do not share that layout.

Co-authored-by: Cursor <cursoragent@cursor.com>
@kliegeois @cursoragent
Fix testing.md copy-paste traps and CI overclaims.
2c666b6 
Correct the rocSPARSE CMake example, matrix-dir typo, and compile-vs-CI GPU list; align hipSPARSE merge-gate wording with TheRock standard.

Co-authored-by: Cursor <cursoragent@cursor.com>
@kliegeois
kliegeois requested review from a team as code owners September 10, 2026 19:43
@therock-pr-bot

therock-pr-bot Bot commented Sep 10, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ All Checks Passed — Ready for Review

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🔎 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

therock-pr-bot Bot commented Sep 10, 2026 •
edited
Loading

Copy link
Copy Markdown

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

dso-amd
dso-amd reviewed Sep 10, 2026
View reviewed changes
Comment thread projects/hipsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 10, 2026
View reviewed changes
Comment thread projects/hipsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 10, 2026
View reviewed changes
Comment thread projects/hipsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 10, 2026
View reviewed changes
Comment thread projects/hipsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
dso-amd
dso-amd reviewed Sep 15, 2026
View reviewed changes
Comment thread projects/rocsparse/clients/tests/testing.md Resolved
@dso-amd

dso-amd commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

I have put in all my comments.

@kliegeois @cursoragent
docs(sparse): address review feedback on testing.md
1ff633f 
Apply reviewer copy-edit suggestions to the rocSPARSE, hipSPARSE, and
rocALUTION testing.md documents:

- Drop first-person plural: "Why We Test This Way" becomes
  "Why <component> is Tested This Way" in all three documents.
- Split run-on "What requires / what runs" sentences into separate
  paragraphs.
- Convert the "Explicitly not tested / guaranteed" run-on lists into
  bullet lists.
- Numerous wording, punctuation, and capitalization fixes.

Co-authored-by: Cursor <cursoragent@cursor.com>
amontoison
amontoison approved these changes Sep 22, 2026
View reviewed changes

@amontoison amontoison left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very useful markdown files. 👍

@kliegeois

kliegeois commented Sep 22, 2026

Copy link
Copy Markdown
Contributor Author

Thanks all for the reviews, @dso-amd I addressed all your comments in @1ff633f .

@kliegeois
kliegeois merged commit b814c45 into develop Sep 23, 2026
37 checks passed
@kliegeois
kliegeois deleted the users/kliegeois/testing-md-initiative branch September 23, 2026 14:34
assistant-librarian Bot pushed a commit to ROCm/hipSPARSE that referenced this pull request Sep 23, 2026
@kliegeois @assistant-librarian
[rocm-libraries] ROCm/rocm-libraries#11944 (commit b814c45)
f3c3994 
docs(sparse): add testing.md for rocSPARSE, hipSPARSE, and
 rocALUTION (#11944)

JIRA ID: AISPARSE-761

## Summary
- Add current-state `testing.md` for rocSPARSE, hipSPARSE, and
rocALUTION (how the suites are structured, what actually gates a merge,
and known gaps).
- Document the rocSPARSE `clients/unittests/` layer now on develop
(`rocsparse-unit-test` / `rocsparse-unit-test-device`), including that
TheRock `standard` still only runs `rocsparse-test`.
- Align hipSPARSE merge-gate wording with TheRock and keep
hipSPARSE/rocALUTION from implying a rocSPARSE-style unit-test binary.

## Test plan
- [ ] Read the three files as a developer: can you build, pick the right
binary, and tell what CI will run?
- [ ] Confirm rocSPARSE unit-test commands (`ctest -R
'^rocsparse-unit-test$'` vs device binary) and the TheRock vs Jenkins
distinction.
- [ ] Confirm hipSPARSE does not claim a `clients/unittests/` layer;
CUDA lane is informational Jenkins, not TheRock.
- [ ] Confirm rocALUTION env-var tiers and the note that Jenkins
`*checkin*`/`*nightly*` filters match no current names.
- Doc-only paths (`*.md`) skip TheRock CI by design.

Made with [Cursor](https://cursor.com)
assistant-librarian Bot pushed a commit to ROCm/rocSPARSE that referenced this pull request Sep 23, 2026
@kliegeois @assistant-librarian
[rocm-libraries] ROCm/rocm-libraries#11944 (commit b814c45)
113cac6 
docs(sparse): add testing.md for rocSPARSE, hipSPARSE, and
 rocALUTION (#11944)

JIRA ID: AISPARSE-761

## Summary
- Add current-state `testing.md` for rocSPARSE, hipSPARSE, and
rocALUTION (how the suites are structured, what actually gates a merge,
and known gaps).
- Document the rocSPARSE `clients/unittests/` layer now on develop
(`rocsparse-unit-test` / `rocsparse-unit-test-device`), including that
TheRock `standard` still only runs `rocsparse-test`.
- Align hipSPARSE merge-gate wording with TheRock and keep
hipSPARSE/rocALUTION from implying a rocSPARSE-style unit-test binary.

## Test plan
- [ ] Read the three files as a developer: can you build, pick the right
binary, and tell what CI will run?
- [ ] Confirm rocSPARSE unit-test commands (`ctest -R
'^rocsparse-unit-test$'` vs device binary) and the TheRock vs Jenkins
distinction.
- [ ] Confirm hipSPARSE does not claim a `clients/unittests/` layer;
CUDA lane is informational Jenkins, not TheRock.
- [ ] Confirm rocALUTION env-var tiers and the note that Jenkins
`*checkin*`/`*nightly*` filters match no current names.
- Doc-only paths (`*.md`) skip TheRock CI by design.

Made with [Cursor](https://cursor.com)
@assistant-librarian

assistant-librarian Bot commented Sep 25, 2026

Copy link
Copy Markdown
Contributor

TheRock Submodule Bump Activity

Newest first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dso-amd dso-amd dso-amd approved these changes
@ntrost57 ntrost57 ntrost57 approved these changes
@amontoison amontoison amontoison approved these changes

Assignees

No one assigned

Labels

ci:docs-only Docs only changes documentation organization: ROCm project: hipsparse project: rocalution project: rocsparse

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@kliegeois @dso-amd @ntrost57 @amontoison @jsandham