docs: Update README.md #2906
docs: Update README.md #2906
Conversation
Update readme Signed-off-by: Harry Kim <[email protected]>
WalkthroughREADME.md updated to add three top navigation links and to modify the Framework Support Matrix: KVBM row marks vLLM and SGLang as complete and TensorRT-LLM as in progress. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
24-24: Prefer relative links and title-case nav labelsConvert absolute GitHub paths for Support Matrix and Examples to relative links, and capitalize labels for consistency:
-| **[Roadmap](https://github.com/ai-dynamo/dynamo/issues/762)** | **[Support matrix](https://github.com/ai-dynamo/dynamo/blob/main/docs/support_matrix.md)** | **[Documentation](https://docs.nvidia.com/dynamo/latest/index.html)** | **[Examples](https://github.com/ai-dynamo/dynamo/tree/main/examples)** | **[Prebuilt containers](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/ai-dynamo/collections/ai-dynamo)** | **[Design Proposals](https://github.com/ai-dynamo/enhancements)** | **[Blogs](https://developer.nvidia.com/blog/tag/nvidia-dynamo)** +| **[Roadmap](https://github.com/ai-dynamo/dynamo/issues/762)** | **[Support Matrix](docs/support_matrix.md)** | **[Documentation](https://docs.nvidia.com/dynamo/latest/index.html)** | **[Examples](examples/)** | **[Prebuilt Containers](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/ai-dynamo/collections/ai-dynamo)** | **[Design Proposals](https://github.com/ai-dynamo/enhancements)** | **[Blogs](https://developer.nvidia.com/blog/tag/nvidia-dynamo)**
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~63-~63: There might be a mistake here.
Context: ...ure/kvbm_architecture.md) | ✅ | ✅ | 🚧 | To learn more about each framework and t...
(QB_NEW_EN)
⏰ 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: Build and Test - dynamo
| | [**Load Based Planner**](/docs/architecture/load_planner.md) | 🚧 | 🚧 | 🚧 | | ||
| | [**SLA-Based Planner**](/docs/architecture/sla_planner.md) | ✅ | ✅ | 🚧 | | ||
| | [**KVBM**](/docs/architecture/kvbm_architecture.md) | 🚧 | 🚧 | 🚧 | | ||
| | [**KVBM**](/docs/architecture/kvbm_architecture.md) | ✅ | ✅ | 🚧 | |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Validate KVBM status across backends; add legend and define acronym on first mention
Ensure the table reflects actual support in vLLM/SGLang and in-progress state for TensorRT-LLM. Consider adding a legend for ✅/🚧 and expanding KVBM on first use to avoid ambiguity.
Repo-level verification:
Suggested additions right below the table:
> Legend: ✅ Available • 🚧 In progress
> KVBM: Briefly define the acronym here (expand the full term) and link to the design doc above.🏁 Script executed:
#!/bin/bash
# Scan for KVBM references across backends to corroborate the matrix.
rg -nPi --hidden --glob '!**/node_modules/**' 'kvbm|kv[-_ ]?aware|kv block memory' -C2 components/ docs/ | sed 's/^/HIT: /'
echo "Note: absence of matches is not proof; check backend READMEs and features as needed."Length of output: 41833
Update KVBM support matrix, add legend, define acronym
- In README.md table row for KVBM, change statuses to: 🚧 for vLLM (WIP), ❌ for SGLang (Planned), 🚧 for TensorRT-LLM.
- Add immediately below the table:
Legend: ✅ Available • 🚧 In progress • ❌ Planned
- On first mention, expand “KVBM” to “KV Block Manager (KVBM)”.
🧰 Tools
🪛 LanguageTool
[grammar] ~63-~63: There might be a mistake here.
Context: ...ure/kvbm_architecture.md) | ✅ | ✅ | 🚧 | To learn more about each framework and t...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In README.md around line 63, update the KVBM table row statuses to use the
requested symbols (set vLLM to 🚧, SGLang to ❌, TensorRT-LLM to 🚧), add a
legend line immediately below the table that reads "Legend: ✅ Available • 🚧 In
progress • ❌ Planned", and change the first occurrence of "KVBM" in the document
to "KV Block Manager (KVBM)". Ensure spacing and markdown table formatting
remain valid and the acronym expansion appears only on first mention.
Signed-off-by: Harry Kim <[email protected]> Signed-off-by: Gavin.Zhu <[email protected]>
Signed-off-by: Harry Kim <[email protected]> Signed-off-by: nnshah1 <[email protected]>
Signed-off-by: Harry Kim <[email protected]> Signed-off-by: nnshah1 <[email protected]>
Update readme with links to support matrix, prebuilt containers from NGC, and blog articles.
Also updated kvbm support for TRT-LLM and vLLM
Summary by CodeRabbit