docs(hip-kernel-provider): refresh rocKE architecture foundations#9764
docs(hip-kernel-provider): refresh rocKE architecture foundations#9764tenpercent wants to merge 6 commits into
Conversation
✅ All Checks Passed — Ready for Review
📖 Need help? See the Policy FAQ for details on every check and how to fix failures. |
|
🎉 All checks passed! This PR is ready for review. |
There was a problem hiding this comment.
Pull request overview
This PR refreshes the rocKE platform documentation set under rocke/platform/dsl_docs/ and reconciles assorted in-code docstrings/comments to match the current platform/library ownership split, architecture catalog, and supported workflows, while adding a point-in-time audit record for the documentation pass.
Changes:
- Edited and reconciled many
dsl_docs/pages to remove stale claims, update anchors/paths, and align with current code/tests/workflows. - Updated docstrings/comments across several platform instance builders and helpers to reflect the current implemented behavior and boundaries.
- Added
dsl_docs/AICK-1593_DOC_AUDIT.mdas an audit inventory for the reviewed documentation set.
Reviewed changes
Copilot reviewed 91 out of 92 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| dnn-providers/hip-kernel-provider/rocke/platform/tests/instances/test_rocke_multiarch.py | Updates an in-test comment pointing to the schedule-hints case study. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/transpose.py | Refreshes transpose instance docstring to reflect current transposed-LDS support and chosen generic path. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/streamk_gemm.py | Updates StreamK GEMM documentation to reflect current MFMA/Atomic implementation notes. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/mx_gemm.py | Rewrites MX GEMM docstring to match current MFMA + explicit scale application behavior and validator constraints. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/matmul_nbits.py | Updates MatMulNBits module docstring to describe current dispatcher/bodies. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/grouped_gemm.py | Updates grouped GEMM docs to reflect the shipped uniform-shape single-launch path and current boundaries. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/gemm_universal.py | Updates schedule-hints comment to reference the current case-study numbering. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/conv_direct_grouped.py | Adjusts comment references for refactor-opportunity tracking location. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/block_scale_gemm.py | Rewrites block-scale GEMM docstring to match current supported subset/validator behavior. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/batched_transpose.py | Updates batched transpose docstring to match current transposed-read support narrative. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/batched_gemm.py | Updates docstring to reflect current SGPR scalarization behavior in universal GEMM. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/_matmul_nbits_large_n.py | Updates large-N body docstring to reflect current unsupported features/boundaries. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/_matmul_nbits_decode_gemv.py | Updates decode-GEMV body docstring to remove milestone phrasing. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/common/_matmul_nbits_common.py | Updates common docstring/comments to reflect current supported families and host-side helpers. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/instances/init.py | Updates re-export documentation for grouped GEMM single-launch availability/boundaries. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/helpers/streamk.py | Updates StreamK helper module docstring to describe current consumer support accurately. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/helpers/reduction.py | Rewords welford_block_reduce docstring to reflect its actual two-moment implementation and guidance. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/helpers/README.md | Updates helper documentation for current module locations/ownership and removes stale roadmap prose. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/helpers/persistent.py | Updates persistent helper docstring wording and references. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/core/ir.py | Updates pin_sgpr docstring example to a current, representative usage pattern. |
| dnn-providers/hip-kernel-provider/rocke/platform/python/rocke/benchmark/gemm/fp16_rcr_sweep.py | Updates sweep harness docstring to point at the current optimization runbook. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/runtime/manifest_schema.md | Reconciles manifest schema docs with current rocKE naming, paths, and attention ownership. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/runtime/limitations.md | Updates runtime limitations with current multi-target catalog and multi-GPU stance/anchors. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/runtime/compile_launch_and_manifest.md | Updates compile/launch documentation with current paths and workflow anchors. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/runtime/comgr_and_hipmodule.md | Updates COMGR/HIP module docs to reflect the shared runtime coexistence resolver and platform-specific behaviors. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/reference/mfma_atom_catalog.md | Updates atom catalog docs to align with current ArchTarget/MMA catalogs and availability notes. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/reference/glossary.md | Updates glossary entries for target catalog, buffer descriptor facts, and wave-size notes. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/reference/env_flags.md | Updates environment flag documentation with corrected paths and ownership locations. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/reference/api_index.md | Updates curated API index to match current exports and the platform/library ownership split. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/README.md | Updates top-level docs README for rocKE platform scope, reading order, and current anchors. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/primitives/wave_and_cross_lane.md | Updates wave/cross-lane documentation to reflect current target catalog and examples. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/primitives/quantization.md | Updates quantization doc references for current module locations/ownership. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/primitives/intrinsics_and_primitives.md | Updates primitives inventory and references to current module layout and implemented boundaries. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/optimization/utilities/tools/dsl_probes/README.md | Updates probe documentation and paths to reflect current repo layout and invocation context. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/optimization/utilities/skills/kernel-launch-guide.md | Replaces stale “skill” stub with a maintained launch checklist and correct references. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/optimization/utilities/skills/isa-inspection-rocke.md | Updates ISA inspection guidance terminology, paths, and probe references. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/optimization/utilities/README.md | Updates optimization utilities overview to match current ownership and tool locations. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/optimization/runbook_mapping.md | Replaces large stale mapping content with a pointer to the maintained compliance map. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/optimization/arch/README.md | Updates arch-reference guidance to be grounded in current ArchTarget/backend/catalog sources. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/ir_lowering/lowering_pipeline.md | Removes stale compile-time estimates and updates target/wave-size descriptions. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/ir_lowering/backend_details.md | Updates backend details to match current target catalog, runtime resolver, and LLVM-flavor detection. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/instances/index.md | Rewrites instances index around platform/library ownership split and current support references. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/instances/gemm.md | Updates GEMM family documentation to reflect current grouped GEMM and StreamK implementation boundaries. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/instances/convolution.md | Updates convolution docs to remove unscoped perf claims and align with current code-visible levers and paths. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/fusion/overview.md | Minor wording update clarifying current attention fusion boundary. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/examples/index.md | Rewrites examples index around current platform example registry and library workflows. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/development/troubleshooting.md | Fixes links/paths and removes stale build-wrapper reference. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/development/setup_guide.md | Updates setup guide to include gfx1250 catalog entry and current constraints. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/development/refactor_opportunities.md | Replaces stale backlog-style prose with a grounded, current refactor-opportunities list. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/development/onboarding.md | Updates onboarding guide to remove stale perf numbers/paths and reflect current library ownership and workflows. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/development/extending.md | Updates extension guidance to the current examples registry and test structure (vs removed prototype wrappers). |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/development/engine_contributing.md | Removes obsolete guidance that permitted local Python/C++ drift; clarifies reference-tree mode as diagnostic only. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/autotune/overview.md | Updates autotune overview to avoid stale timing claims and reflect bounded retuning rationale. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/architecture/transform_dag.md | Corrects implementation anchor path for TensorDescriptor.offset. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/architecture/mental_model.md | Removes stale compile-time point estimates and updates target catalog description. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/architecture/kernel_taxonomy.md | Updates taxonomy to reflect current MFMA/WMMA/warp-body selection and ownership boundaries. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/architecture/index.md | Converts architecture index into a navigational page (no longer duplicating instance catalog content). |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/architecture/backend_support_agpr_res.md | Replaces proposal text with implemented AGPR allocation control interface, behavior, and tests. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/architecture/authoring_model.md | Updates authoring model to reflect platform vs library ownership and same-change parity requirements. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/architecture/attention_2d_gfx942_experiment_summary.md | Updates gfx942 experiment summary anchors/ownership paths and removes transient WIP-path dependencies. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/architecture/attention_2d_experiment_summary.md | Updates gfx950 experiment summary anchors to current library-owned kernel/benchmark paths. |
| dnn-providers/hip-kernel-provider/rocke/platform/dsl_docs/AICK-1593_DOC_AUDIT.md | Adds the point-in-time audit inventory and rationale summary for the docs refresh. |
| dnn-providers/hip-kernel-provider/rocke/library/kernels/common/sparse_attention.py | Updates sparse-attention docs to accurately describe current mask behavior (predicate after load). |
| dnn-providers/hip-kernel-provider/rocke/library/kernels/common/fmha_splitkv_decode.py | Marks use_mfma_body as a reserved compatibility field (no branching in current builder). |
| dnn-providers/hip-kernel-provider/rocke/library/kernels/common/fmha_mfma.py | Updates MFMA/WMMA portability description and explicitly documents gfx1250 rejection rationale. |
| dnn-providers/hip-kernel-provider/rocke/library/kernels/common/fmha_fwd_fp8.py | Updates FP8 FMHA doc/comments to reflect current dequant + narrow MFMA body and re-scoped tuning notes. |
| dnn-providers/hip-kernel-provider/rocke/library/kernels/common/fmha_bwd.py | Marks use_mfma_body as a reserved compatibility field (no branching in current builder). |
| dnn-providers/hip-kernel-provider/rocke/library/kernels/common/_fmha_warp_body.py | Updates boundary description to reflect current MFMA/WMMA callers and ownership split. |
| dnn-providers/hip-kernel-provider/rocke/library/kernels/common/_fmha_common.py | Updates internal-body references to match current organization and shared MFMA helper usage. |
|
Addressed the Copilot path feedback in Validation:
|
|
GPU-programming expert follow-up landed in The pass found and corrected a common class of issue: documentation/spec comments describing intended controls or architectural correlations as implemented behavior.
No runtime semantics changed. AST comparison after removing docstrings reports 0 semantic changes across all 29 Python files in the PR. Current-head validation:
GPU validation already completed for this PR remains applicable to the documented workflows: Slurm job |
a260aca to
a92e1fd
Compare
|
Factual-accuracy review of the current PR head ( Confirmed findings
Verified nuanceThe statement that legal matrix atoms are target/catalog properties rather than consequences of wave width is architecturally correct. Some current builders use wave size as a family-selection shortcut because the checked-in targets correlate, but the target catalog remains the authority for legal atoms. I am addressing these documentation findings in a follow-up commit on this PR. |
|
Addressed the factual-review findings in
Validation: pre-commit passed on all eight changed files, |
|
Second factual-accuracy review of head Confirmed findings
Qualification needed
I am addressing these documentation findings in a follow-up commit on this PR. |
|
Addressed the second factual-review findings in
Validation: pre-commit passed on all eight files, |
|
A further factual-accuracy pass at head
These are source-confirmed documentation issues. I am addressing them in a follow-up commit and will rerun the documentation/static checks. |
|
Addressed the latest factual-review findings in
Validation on the pushed commit:
The PR is now 598 changed lines across the same eight files, still within the documented eight-file overflow ceiling. GPU validation was not rerun because this commit changes documentation only; the earlier gfx950 Kreb |
|
Follow-up factual-accuracy pass in
Validation: focused pre-commit hooks and |
JIRA ID : AICK-1593
Summary
Stage 1 of the five-stage documentation pilot. Refresh the top-level
documentation map and retain core architecture guidance that remains useful and
grounded in the current implementation.
This stage:
platform/python/rocke/instancescontainsplatform-owned kernel instances, including MoE, while attention builders are
library-owned under
library/kernels; reusable authoring mechanics belong inhelpers, and foundational IR, analysis, and lowering belong incore;<project_root>,<platform_root>, and<library_root>so sourcelocations, Python imports, and platform/library ownership are not conflated;
selection: gfx942/gfx950 admit wave64 only, gfx1250 admits wave32 only, and
the current gfx1151/gfx11-generic/gfx1201 catalog rows admit wave32 even
though those targets can select wave64 at compile time; MFMA/WMMA availability
and atom identity come from the exact gfx target and its
MmaCatalog;and strided LDS reads for the V operand, gfx950 variants may use target-specific
transpose LDS reads and wider catalog atoms, and gfx1250 selects its own WMMA
operations and requires wave32 geometry;
pooling, top-k reduction, MoE sorting, attention, and reduction paths;
conclusions inferred from a broad accelerator-family label.
Pilot stage map
This is a five-stage review-workflow pilot. We will stop after Stage 5 and ask
maintainers whether these boundaries are reviewable before splitting any
remaining audit work.
Test plan
git diff --checkpassed.(0, 0)COMGR option sequence against the current Python engine.known_arches()SRD mapping, exact-target MFMA/WMMA catalogs, compile-time wave constraints, platform/library ownership, non-matmul primitive bodies, the implemented multi-ABD subset, and the C++ AGPR parser scope.verify_dsl_docsreported 49 passed and 0 failed; the README implicit-GEMM manifest verification reportedbad=0.