[Docs] Document every implemented op the API reference was missing - #31
Merged
Merged
Conversation
A scan of TileOPs top-level exports and manifest entries against the ::: directives on docs/api/ found 24 public ops with no API page entry. attention.md gains GroupedQueryAttentionDenseFwdOp (added in tile-ai/TileOPs#1975) and an Attention indexing section for FP8LightningIndexerFwdOp. quantization.md and topk.md replace their coming-soon placeholders with FP8QuantFwdOp and TopkSelectorFwdOp, both implemented in the manifest. New pages cover the RoPE (6 ops), pooling (12 ops), convolution (3 ops), and dropout (1 op) families; nav and nav_translations gain the four labels. MoE and Engram ops stay undocumented for now: the MoE family is mid-refactor with spec-only staged ops, and neither family is exported at the tileops.ops top level.
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.
Problems
GroupedQueryAttentionDenseFwdOp([Refactor][Attention] Establish dense GQA Op boundary TileOPs#1975) has docstring formulas but no:::entry onapi/attention.md, so the op and its math never render.api/quantization.mdandapi/topk.mdare coming-soon placeholders while both ops areimplementedin the manifest and exported at the top level.Changes
attention.md: addGroupedQueryAttentionDenseFwdOpunder Grouped-query attention, and an Attention indexing section forFP8LightningIndexerFwdOp.quantization.md,topk.md: replace the placeholders withFP8QuantFwdOpandTopkSelectorFwdOp.rope.md(6 ops),pool.md(12 ops),convolution.md(3 ops),dropout.md(1 op), each following the existing page pattern.mkdocs.yml: four new nav entries plusnav_translationslabels;api/index.md: table rows for the new pages, stale-interface caveats dropped.mkdocs buildrenders all six pages; the Dense GQA $$ formulas arrive as arithmatex blocks. 6 new griffe warnings are missing type annotations in TileOPs docstrings (fp8_quant.py,topk_selector.py,fp8_lightning_indexer.py), same class as the 16 pre-existing ones — the fix belongs upstream.Left out on purpose
tileops.opstop level.MeanPoolingForwardOp: anUnmanifestedOp.