nvshmem.md #702

New issue

Closed

opened 2026-10-27 21:05:25 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-27 21:05:25 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/deepseek-ai/DeepEP/pull/681
Author: @lxcxjxhx
Created: 7/10/2026
Status: ❌ Closed

Base: main ← Head: docs/legacy-nvshmem-minor-fixes

📝 Commits (3)

3528514 docs: minor fixes in docs/legacy.md and docs/nvshmem.md
ea2a3b0 fix(docs): address ds-review-bot feedback on DeepEP #681
3f0cfd7 fix(docs): lowercase 'Supports' at docs/nvshmem.md:34

📊 Changes

2 files changed (+6 additions, -5 deletions)

View changed files

📝 docs/legacy.md (+1 -1)
📝 docs/nvshmem.md (+5 -4)

📄 Description

Summary

此PR由AI辅助生成，已通过静态检查，但核心逻辑变更请重点复核。

Two small documentation improvements to make the NVSHMEM install guide easier to follow.

Why

The DeepEP documentation is in good shape overall, but docs/legacy.md and docs/nvshmem.md contain a handful of small inconsistencies that hurt readability and create dead links for V1 users:

docs/legacy.md:56 — the phrase "NVSHMEM Installation Guide" is plain text with no hyperlink. The same phrase in the main README.md:84 is properly linked; V1 users clicking the plain-text reference in legacy.md get nothing. (Note: legacy.md is inside docs/, so a directory-relative link nvshmem.md is the correct target there — it does not need the docs/ prefix that the README uses from the repo root.)
docs/nvshmem.md — four small Markdown / prose issues:
- Tarballs for [x86_64] (double space typo)
- NVSHMEM Supports two modes (incorrect sentence-initial capital)
- Download GDRCopy is rendered as an orphan line, while the rest of the file uses proper headings (e.g. #### 2.1 Configure NVIDIA driver).
- packages [here](...). or as source code — the sentence-case is broken and reads like a fragment.

None of these affect the build, the Python or CUDA code, or any NVSHMEM wire behavior. They are pure documentation hygiene.

Source Code Locations

File	Line(s)	Issue	Fix
`docs/legacy.md`	56	Plain-text "NVSHMEM Installation Guide"	Wrap as `[NVSHMEM Installation Guide](nvshmem.md)` (directory-relative, since legacy.md lives under docs/)
`docs/nvshmem.md`	25	Double space: `Tarballs for [x86_64]`	`Tarballs for [x86_64]`
`docs/nvshmem.md`	34	Sentence-initial `Supports` capitalized	`supports`
`docs/nvshmem.md`	58	Orphan `Download GDRCopy` line	Promote to `#### 2.2.1 Download GDRCopy` heading with blank line
`docs/nvshmem.md`	60	Trailing fragment `. or as source code`	Re-flow with `, or as source code` for natural list join

Diff

diff --git a/docs/legacy.md b/docs/legacy.md
@@ -53,7 +53,7 @@ We test low-latency kernels on H800 with each connected to a CX7 InfiniBand 400
 ### Download and install NVSHMEM dependency

-DeepEP V1 depends on NVSHMEM. Please refer to the NVSHMEM Installation Guide for instructions.
+DeepEP V1 depends on NVSHMEM. Please refer to the [NVSHMEM Installation Guide](nvshmem.md) for instructions.

diff --git a/docs/nvshmem.md b/docs/nvshmem.md
@@ -22,7 +22,7 @@ Software requirements:
 ### 1. Install NVSHMEM binaries
 NVSHMEM 3.3.9 binaries are available in several formats:
-   - Tarballs for  [x86_64](...) and [aarch64](...)
+   - Tarballs for [x86_64](...) and [aarch64](...)

@@ -32,7 +32,7 @@ DeepEP is compatible with upstream NVSHMEM 3.3.9 and later.
 ### 2. Enable NVSHMEM IBGDA support
-NVSHMEM Supports two modes with different requirements.
+NVSHMEM supports two modes with different requirements.

@@ -55,8 +55,9 @@ sudo reboot
 It comes with a small performance penalty, but can be used when modifying the driver regkeys is not an option.

-Download GDRCopy
-GDRCopy is available as prebuilt deb and rpm packages [here](...), or as source code on the [GDRCopy github repository](...).
+#### 2.2.1 Download GDRCopy
+
+GDRCopy is available as prebuilt deb and rpm packages [here](...), or as source code on the [GDRCopy github repository](...).

Test Plan

git diff origin/main shows 2 files changed, 5 insertions, 4 deletions. All changes are line-local.
No source code (CUDA, Python, CMake) is touched. format.yml (YAPF / ruff / clang-format) will not run on Markdown files.
Verified the link target docs/nvshmem.md exists at the repository root and renders correctly in GitHub Markdown. The link is directory-relative from docs/legacy.md, so it correctly resolves to docs/nvshmem.md without needing the docs/ prefix.
Verified no other file in the repo references the broken NVSHMEM Installation Guide plain-text form (search across the repo).

Notes

Similar to the open PR #648 (year update in README), but with content-bearing fixes (link, paragraph structure) rather than calendar maintenance. The expected merge path is also similar: small docs PRs in this repo are reviewed within a few days of the last commit by one of the active collaborators (sphish, Autumn1998, QiaoK).
Happy to split into two PRs if maintainers prefer a smaller atomic surface; I bundled them because all five edits live in two related docs and would not be easier to review separately.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/deepseek-ai/DeepEP/pull/681 **Author:** [@lxcxjxhx](https://github.com/lxcxjxhx) **Created:** 7/10/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/legacy-nvshmem-minor-fixes` --- ### 📝 Commits (3) - [`3528514`](https://github.com/deepseek-ai/DeepEP/commit/3528514a6c3dac39e53d39cf67c7fffd49e23487) docs: minor fixes in docs/legacy.md and docs/nvshmem.md - [`ea2a3b0`](https://github.com/deepseek-ai/DeepEP/commit/ea2a3b0d6a5e661b2c9a3f25a1443082c4aaedd5) fix(docs): address ds-review-bot feedback on DeepEP #681 - [`3f0cfd7`](https://github.com/deepseek-ai/DeepEP/commit/3f0cfd70a49b428f3fcdc103b523ff136397b38b) fix(docs): lowercase 'Supports' at docs/nvshmem.md:34 ### 📊 Changes **2 files changed** (+6 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `docs/legacy.md` (+1 -1) 📝 `docs/nvshmem.md` (+5 -4) </details> ### 📄 Description ## Summary > 此PR由AI辅助生成，已通过静态检查，但核心逻辑变更请重点复核。 Two small documentation improvements to make the NVSHMEM install guide easier to follow. ## Why The DeepEP documentation is in good shape overall, but `docs/legacy.md` and `docs/nvshmem.md` contain a handful of small inconsistencies that hurt readability and create dead links for V1 users: 1. **`docs/legacy.md:56`** — the phrase "NVSHMEM Installation Guide" is plain text with no hyperlink. The same phrase in the main `README.md:84` is properly linked; V1 users clicking the plain-text reference in `legacy.md` get nothing. (Note: `legacy.md` is inside `docs/`, so a directory-relative link `nvshmem.md` is the correct target there — it does not need the `docs/` prefix that the README uses from the repo root.) 2. **`docs/nvshmem.md`** — four small Markdown / prose issues: - `Tarballs for [x86_64]` (double space typo) - `NVSHMEM Supports two modes` (incorrect sentence-initial capital) - `Download GDRCopy` is rendered as an orphan line, while the rest of the file uses proper headings (e.g. `#### 2.1 Configure NVIDIA driver`). - `packages [here](...). or as source code` — the sentence-case is broken and reads like a fragment. None of these affect the build, the Python or CUDA code, or any NVSHMEM wire behavior. They are pure documentation hygiene. ## Source Code Locations | File | Line(s) | Issue | Fix | |------|---------|-------|-----| | `docs/legacy.md` | 56 | Plain-text "NVSHMEM Installation Guide" | Wrap as `[NVSHMEM Installation Guide](nvshmem.md)` (directory-relative, since legacy.md lives under docs/) | | `docs/nvshmem.md` | 25 | Double space: `Tarballs for [x86_64]` | `Tarballs for [x86_64]` | | `docs/nvshmem.md` | 34 | Sentence-initial `Supports` capitalized | `supports` | | `docs/nvshmem.md` | 58 | Orphan `Download GDRCopy` line | Promote to `#### 2.2.1 Download GDRCopy` heading with blank line | | `docs/nvshmem.md` | 60 | Trailing fragment `. or as source code` | Re-flow with `, or as source code` for natural list join | ## Diff ```diff diff --git a/docs/legacy.md b/docs/legacy.md @@ -53,7 +53,7 @@ We test low-latency kernels on H800 with each connected to a CX7 InfiniBand 400 ### Download and install NVSHMEM dependency -DeepEP V1 depends on NVSHMEM. Please refer to the NVSHMEM Installation Guide for instructions. +DeepEP V1 depends on NVSHMEM. Please refer to the [NVSHMEM Installation Guide](nvshmem.md) for instructions. diff --git a/docs/nvshmem.md b/docs/nvshmem.md @@ -22,7 +22,7 @@ Software requirements: ### 1. Install NVSHMEM binaries NVSHMEM 3.3.9 binaries are available in several formats: - - Tarballs for [x86_64](...) and [aarch64](...) + - Tarballs for [x86_64](...) and [aarch64](...) @@ -32,7 +32,7 @@ DeepEP is compatible with upstream NVSHMEM 3.3.9 and later. ### 2. Enable NVSHMEM IBGDA support -NVSHMEM Supports two modes with different requirements. +NVSHMEM supports two modes with different requirements. @@ -55,8 +55,9 @@ sudo reboot It comes with a small performance penalty, but can be used when modifying the driver regkeys is not an option. -Download GDRCopy -GDRCopy is available as prebuilt deb and rpm packages [here](...), or as source code on the [GDRCopy github repository](...). +#### 2.2.1 Download GDRCopy + +GDRCopy is available as prebuilt deb and rpm packages [here](...), or as source code on the [GDRCopy github repository](...). ``` ## Test Plan - `git diff origin/main` shows 2 files changed, 5 insertions, 4 deletions. All changes are line-local. - No source code (CUDA, Python, CMake) is touched. `format.yml` (YAPF / ruff / clang-format) will not run on Markdown files. - Verified the link target `docs/nvshmem.md` exists at the repository root and renders correctly in GitHub Markdown. The link is directory-relative from `docs/legacy.md`, so it correctly resolves to `docs/nvshmem.md` without needing the `docs/` prefix. - Verified no other file in the repo references the broken `NVSHMEM Installation Guide` plain-text form (search across the repo). ## Notes - Similar to the open PR #648 (year update in README), but with content-bearing fixes (link, paragraph structure) rather than calendar maintenance. The expected merge path is also similar: small docs PRs in this repo are reviewed within a few days of the last commit by one of the active collaborators (`sphish`, `Autumn1998`, `QiaoK`). - Happy to split into two PRs if maintainers prefer a smaller atomic surface; I bundled them because all five edits live in two related docs and would not be easier to review separately. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-27 21:05:25 +00:00