Add comprehensive documentation guides and improve existing docs#164
Closed
Add comprehensive documentation guides and improve existing docs#164
Conversation
There was a problem hiding this comment.
Pull request overview
This PR expands and refreshes MORI’s documentation set by adding new end-to-end guides (EP + Shmem) and improving existing docs/README for clearer onboarding, API discovery, and benchmarking/profiling usage.
Changes:
- Added new comprehensive guides for MORI-EP and MORI Shmem, including API references and usage examples.
- Improved MORI-IO intro/benchmark docs with quick-reference tables, ToCs, and formatting/clarity fixes.
- Updated README with a documentation index, reorganized feature presentation, and a Quick Start snippet.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/PROFILER.md | Adds ToC and corrects profiler constant text; improves wording around device-side timing. |
| docs/MORI-SHMEM-GUIDE.md | Introduces a new Shmem guide covering concepts, init methods, APIs, env vars, and source references. |
| docs/MORI-IO-INTRO.md | Adds ToC, Python API quick reference tables, and an end-to-end example plus config/source file pointers. |
| docs/MORI-IO-BENCHMARK.md | Adds ToC, converts arguments to a table, and restructures results sections for readability. |
| docs/MORI-EP-GUIDE.md | Adds a new EP user guide with kernel types, config reference, operator API coverage, examples, and integration notes. |
| docs/MORI-EP-BENCHMARK.md | Adds ToC and refines inter-node benchmark instructions and NIC selection section. |
| README.md | Adds documentation index/table, refreshes Features, and introduces a MORI-EP Quick Start example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
9f3f166 to
d6fc5a1
Compare
Collaborator
|
Thanks @sunway513 for the great contribution! We will verify the doc and merge it. |
New guides: - MORI-EP Guide: kernel types, full Python API reference, config fields, usage examples, launch config modes, standard MoE compatibility, benchmarking, framework integration, build options - MORI Shmem Guide: symmetric memory concepts, initialization methods, query APIs, memory management, P2P translation, synchronization Improved existing docs: - MORI-IO-INTRO: Add Python API quick reference with class/method/enum tables, code example, environment config, source files; fix StatusCode enum values, session API usage, XGMI backend status - MORI-IO-BENCHMARK: Add ToC, format arguments as table - MORI-EP-BENCHMARK: Add ToC, fix typos, improve formatting - PROFILER: Add ToC, fix warps-per-rank constant (512->4096) Updated README with Documentation table linking all 6 guides, restructured Features section, added Quick Start example and Framework Integration table.
d6fc5a1 to
79e2347
Compare
Collaborator
|
PR #181 has already covered this PR and been merged. I will now close this PR. |
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
docs/MORI-EP-GUIDE.md): kernel types, full Python API reference for config (17 fields) and operator (all methods), usage examples, launch config modes, standard MoE compatibility, benchmarking, framework integration, build optionsdocs/MORI-SHMEM-GUIDE.md): symmetric memory concepts, PE model, two initialization methods, query APIs, memory management, P2P address translation, synchronizationFact-Checked
All documentation verified against source code:
Test plan