Add Apple Metal compute documentation suite#180
Open
qhy991 wants to merge 4 commits intoandrewyng:mainfrom
Open
Add Apple Metal compute documentation suite#180qhy991 wants to merge 4 commits intoandrewyng:mainfrom
qhy991 wants to merge 4 commits intoandrewyng:mainfrom
Conversation
Improve Context Hub retrieval for PTX/CUDA instruction references by providing translated content and searchable tags. Made-with: Cursor
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
Add a substantial Apple Metal compute documentation suite for Context Hub, with a
cpp-first focus for macOS kernel and host-wrapper development.Changes
content/apple/docs/...content/apple/docs/pytorch-mps-vs-custom-metal/python/DOC.mdscripts/search_regression_baseline.jsonWhat
This adds a practical, agent-friendly Apple Metal documentation track so coding agents can retrieve authoritative guidance for macOS compute kernel development without falling back immediately to generic web search.
The new docs are written to support:
Why
Context Hub already had strong CUDA/PTX coverage, but there was no comparable local documentation path for Metal.
That gap matters because Metal compute development has its own semantics and failure modes:
mpsunless local docs make those boundaries explicitThis PR improves local retrieval quality for Apple Metal topics and gives agents a
cpp-first reference path for macOS GPU programming.Testing
Content quality:
content/apple/docsBuild and regression:
./cli/bin/chub build content --validate-only— passed (1670 docs, 6 skills, 0 warnings)./cli/bin/chub build content— passedpython3 scripts/search_regression.py --mode check— passed (64/64)python3 scripts/search_regression.py --mode snapshot --snapshot-out scripts/search_regression_baseline.json— passedrg -n "[\p{Han}]" content/apple/docs | wc -l—0Sources
Apple official documentation used for extraction:
PyTorch official documentation used for the boundary doc:
Notes
Primary sources used for extraction were Apple Metal official documentation and tools pages, with PyTorch docs used only for the MPS-vs-custom-Metal boundary doc.