Skip to content

docs(primbench) add general primbench doc - #10493

Merged
spolifroni-amd merged 13 commits into
developfrom
users/spolifroni-amd/primbench/add-general-primbench-doc
Sep 3, 2026
Merged

spolifroni-amd merged 13 commits into
developfrom
users/spolifroni-amd/primbench/add-general-primbench-doc

Conversation

@spolifroni-amd

Copy link
Copy Markdown
Contributor

Motivation

Adding some general primbench doc so it can be taken out of individual components.

JIRA ID : AIROCDOC-4120

@therock-pr-bot

therock-pr-bot Bot commented Aug 6, 2026 •

Copy link
Copy Markdown

✅ All Checks Passed — Ready for Review

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ⚠️ Warning Error: Source/code files changed without an accompanying unit test.
Expected: add at least one test file named like test_<name>.py / test_<name>.cpp (or <name>_test.*).
Current: code file(s) changed: shared/primbench/docs/conf.py; no test file found
🔎 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 Aug 6, 2026

Copy link
Copy Markdown

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

@anisha-amd anisha-amd 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.

Peer review complete:

  1. Check: swapped --min-gpu-temp``/--max-gpu-temp descriptions; conflicting state.test() timing between validate-output and API reference.
  2. Broken/missing links: cli-options → noise-reduction file path; tutorials/copy-benchmark not in PR.
  3. Content dedup suggestion: primbench-output.rst vs json-output-format.rst overlap.

Comment thread shared/primbench/docs/index.rst Resolved
spolifroni-amd and others added 9 commits August 11, 2026 15:13
Co-authored-by: anisha-amd <anisha.sankar@amd.com>
Co-authored-by: anisha-amd <anisha.sankar@amd.com>
Co-authored-by: anisha-amd <anisha.sankar@amd.com>
Co-authored-by: anisha-amd <anisha.sankar@amd.com>
Co-authored-by: anisha-amd <anisha.sankar@amd.com>
Co-authored-by: anisha-amd <anisha.sankar@amd.com>
Co-authored-by: anisha-amd <anisha.sankar@amd.com>
Comment thread shared/primbench/docs/conf.py Resolved
@spolifroni-amd

Copy link
Copy Markdown
Contributor Author

/docs-preview

@spolifroni-amd
spolifroni-amd enabled auto-merge (squash) September 3, 2026 21:21
@spolifroni-amd
spolifroni-amd merged commit f8631de into develop Sep 3, 2026
21 checks passed
@spolifroni-amd
spolifroni-amd deleted the users/spolifroni-amd/primbench/add-general-primbench-doc branch September 3, 2026 21:23
@assistant-librarian

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants