Fix 06-12-26: Add housekeeping and output buttons#44
Merged
Conversation
* Add acceptance criteria checklist with single/multi-node validation breakdown Restructure MI350X and MI355X GPU pages: - Split System Validation into Single-Node and Multi-Node test tables - Add run-time requirements to all validation tests - Add gfx_lvl4 recipe (previously missing from GPU summary pages) - Update hbm_lvl5 from 2 iterations to 4 iterations (8 hours) - Promote miniHPL from optional to required (3 hours) - Surface multi-node tests (OFED, multi-node RCCL, AI workloads) directly on GPU pages. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
* Add markdown button and make llms.txt available * Add base llms.txt, treshold and exclude MyST directives * Add RST file content to llms.txt * Add llms-full.txt and keep the llms.txt as base * Update the filter function of llms-full.txt generation * sync llms filter fixes from rocm-docs-core * sync llms filter fixes from rocm-docs-core - Add _TRAILING_HTML_CLOSE_RE to strip trailing HTML close tags from prose lines - Add in_html_comment state to discard HTML comment blocks (<!-- ... -->) - Add in_html_open_tag state to discard multi-line HTML opening tag continuations * llms: drop punctuation-only lines after stripping trailing HTML close tags Lines like ".</p>" from sphinx-design grid cards pass _is_prose_line because they start with ".". After stripping "</p>", the remaining content is a bare "." with no word characters and should be discarded. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
mbenavidez-amd
requested review from
nithya-soundar24 and
rzimmer512
as code owners
mbenavidez-amd
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
This pull request introduces several documentation improvements and corrections to the ROCm system acceptance and validation guides, with a focus on clarity, accuracy, and enhanced automation for documentation processing. The most significant changes include the addition of a script to generate a combined markdown file for LLM consumption, corrections to benchmark units, improvements to acceptance checklists and system validation instructions, and various minor fixes.
Technical Details
Documentation automation and tooling:
docs/conf.py: Added a script that processes all markdown and reStructuredText files, extracts prose content, and generates a combinedllms-full.txtfile for use with LLMs, while excluding code blocks, directives, and non-prose lines.docs/conf.py: Enabled the download button in the documentation theme and includedllms.txtin the extra files to be copied to the output.Acceptance criteria and validation instructions:
docs/gpus/mi350x.md: Rewrote the acceptance criteria section as a checklist, clarified the sequence and requirements for single-node and multi-node system validation, and detailed required tests, run times, and pass criteria.Benchmark and command corrections:
docs/gpus/mi300x.md,docs/gpus/mi325x.md: Corrected benchmark units from TFLOPS to GFLOPS for rocBLAS GEMM tests and clarified BabelStream table headers.docs/common/system-setup.md: Fixed theamd-smiversion command for consistency with ROCm documentation.General documentation improvements:
docs/common/system-validation.md: Added links to rocBLAS installation guides, clarified AGFHC installation instructions, and updated AGFHC recipe tables and total run time.These changes collectively improve the usability, accuracy, and maintainability of the Instinct system acceptance documentation.
Test Plan
Run successful local build of documentation with no blocking errors.
Test Result
Confirmed successful build with not blocking errors.
Submission Checklist