Skip to content

docs: Refactor README.md and add components/README.md #2141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
athreesh merged 13 commits into from
Jul 29, 2025
Merged

docs: Refactor README.md and add components/README.md #2141

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f46827d
Update to README.md
athreesh Jul 28, 2025
33be4f1
added NATS/etcd to ReadME + created ReadME for components
athreesh Jul 28, 2025
5160978
changes to root ReadME + added in ReadME for components
athreesh Jul 28, 2025
c4df262
Update components README.md
athreesh Jul 28, 2025
254e711
fix docker compose NATS command
athreesh Jul 28, 2025
087f55e
Merge branch 'refactor-readme' of https://github.com/ai-dynamo/dynamo…
athreesh Jul 28, 2025
ce18586
address feedback from Itay, smaller images + updates to progress
athreesh Jul 28, 2025
5bf38d0
neal adjustments
athreesh Jul 28, 2025
2f63f1f
removing metrics highlight per ryan suggestion
athreesh Jul 29, 2025
54957c8
ryan suggestion on header
athreesh Jul 29, 2025
f828878
fix framework matrix hyperlinks
athreesh Jul 29, 2025
4b4ea9c
fix: Remove trailing whitespace (pre-commit hook)
athreesh Jul 29, 2025
36c8c17
Merge branch 'main' into refactor-readme
athreesh Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update components README.md 
Signed-off-by: Anish <80174047+athreesh@users.noreply.github.com>
  • Loading branch information
@athreesh
athreesh authored Jul 28, 2025
commit c4df262e920f5e0e0388783405f1dd3556ebd8f7
8 changes: 2 additions & 6 deletions components/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,7 @@ Dynamo supports multiple inference engines (with a focus on SGLang, vLLM, and Te
- **[SGLang](backends/sglang/README.md)** - Structured generation language framework with ZMQ-based communication
- **[TensorRT-LLM](backends/trtllm/README.md)** - NVIDIA's optimized LLM inference engine with TensorRT acceleration

Each engine provides launch scripts for different deployment patterns in their respective `/launch` & `/deploy` directories:
- Aggregated serving
- Aggregated serving with KV routing
- Disaggregated serving
- Disaggregated serving with KV routing
Each engine provides launch scripts for different deployment patterns in their respective `/launch` & `/deploy` directories.

## Core Components

Expand Down Expand Up @@ -111,4 +107,4 @@ To get started with Dynamo components:
4. **Run deployment scripts** from the engine's launch directory
5. **Monitor performance** using the metrics component

For detailed instructions, see the README files in each component directory and the main [Dynamo documentation](../../docs/).
For detailed instructions, see the README files in each component directory and the main [Dynamo documentation](../../docs/).
Loading