Skip to content

chore: add deepep install instruction#1136

Merged
terrykong merged 1 commit intomainfrom
yukih/deepep-instruction
Sep 19, 2025
Merged

chore: add deepep install instruction#1136
terrykong merged 1 commit intomainfrom
yukih/deepep-instruction

Conversation

@yuki-97
Copy link
Contributor

@yuki-97 yuki-97 commented Sep 16, 2025

As title.

Summary by CodeRabbit

  • Documentation
    • Clarified bare-metal installation requirements for vLLM’s deep_ep dependency, noting that libibverbs-dev may be needed and providing example apt-get commands.
    • Added inline notes to the dependency configuration highlighting the libibverbs-dev requirement.
    • No functional changes, dependency updates, or build behavior modifications.

Signed-off-by: Yuki Huang <yukih@nvidia.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 16, 2025

Walkthrough

Adds installation notes about libibverbs-dev for deep_ep when installing vLLM outside containers. README gains a note and shell snippet; pyproject.toml gains comment lines under the vllm dependency section. No code, dependency, or build behavior changes.

Changes

Cohort / File(s) Summary of changes
Docs: installation notes
README.md, pyproject.toml
Added documentation/comments noting deep_ep may require libibverbs-dev on bare metal, including example apt-get commands. No functional or dependency updates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my ears at README’s glow,
A tiny note to help installs go.
apt-get whispers, verbs in tow—
No code to tweak, just learn and know.
Hop, hop! The build paths smoothly flow. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "chore: add deepep install instruction" accurately and concisely reflects the main change in the diff (adding installation notes for the deep_ep/deepep dependency in README and pyproject comments), so it is directly related to the changeset and clearly conveys the PR's purpose. It is short, specific, and appropriate for a chore-style change.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch yukih/deepep-instruction

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
README.md (1)

108-113: Add cross‑distro note for non‑Debian systems.

Improves portability for RHEL/CentOS/Rocky users.

Apply this diff to append a brief tip:

 If you encounter problems when installing vllm's dependency deep_ep on bare-metal (outside of a container), you may need to install libibverbs-dev as well. Here is how you can install it:
 ```sh
 sudo apt-get update
 sudo apt-get install libibverbs-dev

+> [!TIP]
+> On RHEL/CentOS/Rocky Linux, install the equivalent development package:
+> sudo dnf install rdma-core-devel


</blockquote></details>
<details>
<summary>pyproject.toml (1)</summary><blockquote>

`71-73`: **Prefer docs over shell command comments in pyproject.**

Keeping install commands in README avoids drift and keeps pyproject clean. Replace with a pointer to the README section.

Apply this diff:

```diff
-    # deep_ep also needs libibverbs-dev
-    # sudo apt-get update
-    # sudo apt-get install libibverbs-dev
+    # DeepEP build on bare-metal requires libibverbs headers; see README ("Bare-metal prerequisites for vLLM/DeepEP").
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 52f1d6a and e726eb1.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • pyproject.toml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Lint check
🔇 Additional comments (1)
README.md (1)

108-113: LGTM: Clear guidance for DeepEP on bare‑metal.

Helpful addition; matches common DeepEP/rdma-core headers requirement outside containers.

@terrykong terrykong added this pull request to the merge queue Sep 16, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Sep 17, 2025
@terrykong terrykong added the CI:docs Run doctest label Sep 19, 2025
@terrykong terrykong enabled auto-merge (squash) September 19, 2025 00:56
@terrykong terrykong merged commit e433d40 into main Sep 19, 2025
48 checks passed
@terrykong terrykong deleted the yukih/deepep-instruction branch September 19, 2025 01:37
PrinsYin pushed a commit to PrinsYin/RL that referenced this pull request Nov 30, 2025
Signed-off-by: Yuki Huang <yukih@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants