docs(merlin): add In-Network Compute (INC) documentation - #35
Open
deanchester wants to merge 1 commit into
Open
Conversation
- Add InNetworkCompute overview page - Add INCQuickStart guide - Update sidebar with merlin category listing the new pages
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
Adds user-facing documentation for the Merlin In-Network Compute (INC) feature to the SST docs site. INC lets Merlin routers intercept packets in-flight and offload collective operations (e.g. reductions) to per-port accelerator subcomponents, reducing collective latency and bandwidth in HPC fabrics.
This PR is documentation-only — no source or site-infrastructure changes beyond the sidebar wiring.
What's included
docs/elements/merlin/InNetworkCompute.md— conceptual overview:PortControlviastartINC(), theAcceleratorsubcomponent API, the router's INC hooks, theincEventtype, and topology awareness (getRtrLevel()/isUpPort())collective_accelring accelerator (lport/rport,RING_TYPEmodes, timing model)merlin.inc_nictest endpoint and its parametersdocs/elements/merlin/INCQuickStart.md— hands-on guide:fattree_inc_test.py(topology"4,2:4"→ 16 hosts, router config,INCJobsetup,system.build(), post-buildwireAccelerators()ring wiring, running it → 430 ns)INCJobparameter reference, test-suite registration, and an "adapting the example" sectionwebsite/sidebars.js— converts the baremerlinentry into a category object (matching theember/memHierarchypattern), keepingintroas the landing page and listing the two new INC pages.Testing
npm run start; both new pages render and appear under the expandable merlin category in the sidebar.sidebars.jsvalidated vianode -e "require('./website/sidebars.js')".Notes
sst-elementschange; no code in this repo is affected.merlin/intro.mdis unchanged and now serves as the category landing page.