-
Notifications
You must be signed in to change notification settings - Fork 753
docs: Examples README/restructuring #2174
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.
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
Merged
Changes from 14 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
6eeda55
removed SDK mentions and slight tidying up
athreesh 581cc7f
Merge branch 'main' of https://github.com/ai-dynamo/dynamo
athreesh d3a66e9
added an EKS example
athreesh ceb1564
Merge branch 'main' of https://github.com/ai-dynamo/dynamo
athreesh ba8bf2f
Merge remote changes: resolve conflicts in TensorRT-LLM README and di…
athreesh 2ee123d
Merge branch 'main' of https://github.com/ai-dynamo/dynamo
athreesh 804813f
added a PR for README + organized examples folder
athreesh c4e8b4e
fix: Remove trailing whitespace (pre-commit hook)
athreesh 2de7649
minor updates to UX in readmes for vLLM/TRT-LLM
athreesh b434ad1
updated TRT-LLM readme broken link
athreesh 14d9847
Merge main into examples-changes
athreesh 6568d67
Merge branch 'main' into examples-changes
athreesh e9dc0cb
Resolve merge conflicts in README files
athreesh 048bfe0
Merge branch 'examples-changes' of https://github.com/ai-dynamo/dynam…
athreesh 372c290
Update docs/architecture/distributed_runtime.md
athreesh 4cf7632
Update docs/architecture/distributed_runtime.md
athreesh 16f5e2a
Merge branch 'main' into examples-changes
athreesh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
| # Dynamo Examples | ||
|
|
||
| This directory contains practical examples demonstrating how to deploy and use Dynamo for distributed LLM inference. Each example includes setup instructions, configuration files, and explanations to help you understand different deployment patterns and use cases. | ||
|
|
||
| > **Want to see a specific example?** | ||
| > Open a [GitHub issue](https://github.com/ai-dynamo/dynamo/issues) to request an example you'd like to see, or [open a pull request](https://github.com/ai-dynamo/dynamo/pulls) if you'd like to contribute your own! | ||
|
|
||
| ## Basics & Tutorials | ||
|
|
||
| Learn fundamental Dynamo concepts through these introductory examples: | ||
|
|
||
| - **[Quickstart](basics/quickstart/README.md)** - Simple aggregated serving example with vLLM backend | ||
| - **[Disaggregated Serving](basics/disaggregated_serving/README.md)** - Prefill/decode separation for enhanced performance and scalability | ||
| - **[Multi-node](basics/multinode/README.md)** - Distributed inference across multiple nodes and GPUs | ||
| - **[Multimodal](basics/multimodal/README.md)** - Multimodal model deployment with E/P/D disaggregated serving | ||
|
|
||
| ## Deployment Examples | ||
|
|
||
| Platform-specific deployment guides for production environments: | ||
|
|
||
| - **[Amazon EKS](deployments/EKS/)** - Deploy Dynamo on Amazon Elastic Kubernetes Service | ||
| - **[Azure AKS](deployments/AKS/)** - Deploy Dynamo on Azure Kubernetes Service | ||
| - **[Router Standalone](deployments/router_standalone/)** - Standalone router deployment patterns | ||
| - **Amazon ECS** - _Coming soon_ | ||
| - **Google GKE** - _Coming soon_ | ||
| - **Ray** - _Coming soon_ | ||
| - **NVIDIA Cloud Functions (NVCF)** - _Coming soon_ | ||
|
|
||
| ## Runtime Examples | ||
|
|
||
| Low-level runtime examples for developers using Python<>Rust bindings: | ||
|
|
||
| - **[Hello World](runtime/hello_world/README.md)** - Minimal Dynamo runtime service demonstrating basic concepts | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. **Choose your deployment pattern**: Start with the [Quickstart](basics/quickstart/README.md) for a simple local deployment, or explore [Disaggregated Serving](basics/disaggregated_serving/README.md) for advanced architectures. | ||
|
|
||
| 2. **Set up prerequisites**: Most examples require etcd and NATS services. You can start them using: | ||
| ```bash | ||
| docker compose -f deploy/metrics/docker-compose.yml up -d | ||
| ``` | ||
|
|
||
| 3. **Follow the example**: Each directory contains detailed setup instructions and configuration files specific to that deployment pattern. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before running any examples, ensure you have: | ||
|
|
||
| - **Docker & Docker Compose** - For containerized services | ||
| - **CUDA-compatible GPU** - For LLM inference (except hello_world, which is non-GPU aware) | ||
| - **Python 3.9++** - For client scripts and utilities | ||
| - **Kubernetes cluster** - For any cloud deployment/K8s examples | ||
|
|
||
| ## Framework Support | ||
|
|
||
| These examples show how Dynamo broadly works using major inference engines. | ||
|
|
||
| If you want to see advanced, framework-specific deployment patterns and best practices, check out the [Components Workflows](../components/backends/) directory: | ||
| - **[vLLM](../components/backends/vllm/)** – vLLM-specific deployment and configuration | ||
| - **[SGLang](../components/backends/sglang/)** – SGLang integration examples and workflows | ||
| - **[TensorRT-LLM](../components/backends/trtllm/)** – TensorRT-LLM workflows and optimizations |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.