docs: add hardware benchmark dashboard template#172
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a new documentation page ChangesHardware Benchmark Dashboard Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/benchmarking/hardware-dashboard.md (1)
54-63: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick winAlign code fence indentation with opening fence.
The closing triple-backticks on line 63 has leading whitespace (2 spaces), while the opening fence on line 54 is flush-left. While technically valid Markdown, this is inconsistent and reduces readability. Move the closing fence to column 0 to match the opening.
📝 Proposed fix for fence alignment
python scripts/run_profile_suite.py \ --device cuda \ --dtype float16 \ --batch-sizes 8,16,32 \ --seq-lens 128,512 \ --vocab-sizes 4096,128256 \ --workloads logp-native,logp-fused \ --output reports/logp_profile.csv - ``` +```🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/benchmarking/hardware-dashboard.md` around lines 54 - 63, The closing code fence (triple-backticks) has two leading spaces of indentation while the opening code fence is flush-left at column 0. Remove the leading whitespace from the closing fence to align it with the opening fence, ensuring both are at column 0 for consistent Markdown formatting.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/benchmarking/hardware-dashboard.md`:
- Around line 54-63: The closing code fence (triple-backticks) has two leading
spaces of indentation while the opening code fence is flush-left at column 0.
Remove the leading whitespace from the closing fence to align it with the
opening fence, ensuring both are at column 0 for consistent Markdown formatting.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9a6de270-b75e-4081-82c7-da13f20f0397
📒 Files selected for processing (3)
docs/.nav.ymldocs/benchmarking/README.mddocs/benchmarking/hardware-dashboard.md
|
cc @inaniloquentee @z1ying @a-kaa PTAL |
|
LGTM. Thank you for contribution! |
|
@smarslou Thanks for the PR, just a heads-up that your local Git email isn't linked to your GitHub account, so please add it to your GitHub Settings to link these commits and claim your Contributor badge! |
Summary
Scope
This PR establishes the documentation template and reporting rules only.
It does not add measured H100 or MI300 benchmark results.
Validation
git diff --cached --checkmkdocs build --strict -f mkdocs.yamlPart of #20
Summary by CodeRabbit