Add core operator documentation guides and update README#2002
Open
Add core operator documentation guides and update README#2002
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds operator-focused documentation guides for core AITER components and refreshes the main README to improve installation guidance and provide a linked “Supported Operators” index.
Changes:
- Added multiple operator guides under
docs/covering API usage, backend support, and tuning notes. - Added a consolidated “Supported Operators” table to the README linking to the new guides.
- Expanded README installation instructions (JIT dev mode, prebuild options, environment variables, Iris comms).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/attention_variants_guide.md | New guide documenting attention variants and backend selection. |
| docs/mla_kernel_support_report.md | New MLA variants/support report and usage guidance. |
| docs/moe_variants_guide.md | New MOE variants guide including routing/quantization/backend notes. |
| docs/gemm_variants_guide.md | New GEMM variants/tuning guide including configs and backends. |
| docs/quantization_guide.md | New quantization guide (FP8/MXFP4/INT4, fused ops, KV cache). |
| docs/normalization_guide.md | New normalization guide (RMSNorm/LayerNorm/GroupNorm + fusions). |
| docs/rope_guide.md | New RoPE guide (formats, backends, env selection, fused paths). |
| docs/kv_cache_guide.md | New KV-cache management guide (layouts, quantization, fused cache ops). |
| docs/elementwise_activation_guide.md | New elementwise/activation guide including fused quantization paths. |
| docs/sampling_guide.md | New sampling guide (greedy/random/mixed, top-k/top-p ops). |
| README.md | Updated installation instructions and added supported-operators index. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
f36aac8 to
c28edc3
Compare
Add comprehensive documentation guides for 10 core AITER operators: Attention (MHA/PA), MLA, Fused MOE, GEMM, Quantization, Normalization, RoPE, KV-Cache, Elementwise/Activations, and Sampling. Each guide covers available variants, backend support (ASM/CK/Triton), Python API examples, and performance tuning advice. Update README with improved installation instructions (JIT dev mode, precompiled kernels, build variables) and a new Supported Operators table linking to each guide.
c28edc3 to
50f7727
Compare
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
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.
Summary
Files
docs/attention_variants_guide.mddocs/mla_kernel_support_report.mddocs/moe_variants_guide.mddocs/gemm_variants_guide.mddocs/quantization_guide.mddocs/normalization_guide.mddocs/rope_guide.mddocs/kv_cache_guide.mddocs/elementwise_activation_guide.mddocs/sampling_guide.mdREADME.mdGuide Structure
Each guide follows a consistent format: