Skip to content

Add comprehensive documentation guides and improve existing docs#164

Closed
sunway513 wants to merge 1 commit intoROCm:mainfrom
sunway513:docs/comprehensive-guides
Closed

Add comprehensive documentation guides and improve existing docs#164
sunway513 wants to merge 1 commit intoROCm:mainfrom
sunway513:docs/comprehensive-guides

Conversation

@sunway513
Copy link
Copy Markdown
Collaborator

Summary

  • Add MORI-EP User Guide (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 options
  • Add MORI Shmem Guide (docs/MORI-SHMEM-GUIDE.md): symmetric memory concepts, PE model, two initialization methods, query APIs, memory management, P2P address translation, synchronization
  • Improve 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
  • Improve MORI-IO-BENCHMARK: Add ToC, format arguments as table, improve readability
  • Improve MORI-EP-BENCHMARK: Add ToC, fix typos, improve formatting
  • Improve PROFILER: Add ToC, fix warps-per-rank constant (512→4096), fix typos
  • Update README.md with Documentation table, restructured Features, Quick Start example, Framework Integration table

Fact-Checked

All documentation verified against source code:

  • Every API function name, parameter, and default value
  • All enum values and import paths (StatusCode: 8 values verified against pybind)
  • All file paths in Source Files tables
  • Build options against CMakeLists.txt
  • Profiler constants against constants.hpp
  • Environment variable names against source

Test plan

  • Verify all guide links from README resolve correctly
  • Verify code examples match actual API usage patterns

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/MORI-EP-GUIDE.md Outdated
Comment thread docs/MORI-SHMEM-GUIDE.md Outdated
Comment thread docs/MORI-SHMEM-GUIDE.md Outdated
Comment thread docs/PROFILER.md
Comment thread README.md Outdated
@sunway513 sunway513 force-pushed the docs/comprehensive-guides branch from 9f3f166 to d6fc5a1 Compare February 9, 2026 03:25
@TianDi101
Copy link
Copy Markdown
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.
@sunway513 sunway513 force-pushed the docs/comprehensive-guides branch from d6fc5a1 to 79e2347 Compare March 4, 2026 05:41
@jhchouuu
Copy link
Copy Markdown
Collaborator

PR #181 has already covered this PR and been merged. I will now close this PR.

@jhchouuu jhchouuu closed this Mar 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants