Skip to content

Commit e32fe67

Browse files
docs: add message to guide users to the stable version (#1457)
1 parent adeaa90 commit e32fe67

File tree

9 files changed

+106
-0
lines changed

9 files changed

+106
-0
lines changed

docs/examples/llm_deployment.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ limitations under the License.
1919

2020
This directory contains examples and reference implementations for deploying Large Language Models (LLMs) in various configurations.
2121

22+
## Use the Latest Release
23+
24+
We recommend using the latest stable release of dynamo to avoid breaking changes:
25+
26+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
27+
28+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
29+
30+
```bash
31+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
32+
```
33+
2234
## Components
2335

2436
- workers: Prefill and decode worker handles actual LLM inference

docs/examples/multinode.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ limitations under the License.
1818

1919
# Multinode Examples
2020

21+
## Use the Latest Release
22+
23+
We recommend using the latest stable release of dynamo to avoid breaking changes:
24+
25+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
26+
27+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
28+
29+
```bash
30+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
31+
```
32+
2133
## Single node sized models
2234
You can deploy dynamo on multiple nodes via NATS/ETCD based discovery and communication. Here's an example of deploying disaggregated serving on 3 nodes using `nvidia/Llama-3.1-405B-Instruct-FP8`. Each node must be properly configured with Infiniband and/or RoCE for communication between decode and prefill workers.
2335

docs/examples/trtllm.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ limitations under the License.
1919

2020
This directory contains examples and reference implementations for deploying Large Language Models (LLMs) in various configurations using TensorRT-LLM.
2121

22+
## Use the Latest Release
23+
24+
We recommend using the latest stable release of dynamo to avoid breaking changes:
25+
26+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
27+
28+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
29+
30+
```bash
31+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
32+
```
2233

2334
## Deployment Architectures
2435

examples/llm/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ limitations under the License.
1919

2020
This directory contains examples and reference implementations for deploying Large Language Models (LLMs) in various configurations.
2121

22+
## Use the Latest Release
23+
24+
We recommend using the latest stable release of dynamo to avoid breaking changes:
25+
26+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
27+
28+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
29+
30+
```bash
31+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
32+
```
33+
2234
## Components
2335

2436
- workers: Prefill and decode worker handles actual LLM inference

examples/multimodal/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,18 @@ limitations under the License.
2020
This directory provides example workflows and reference implementations for deploying a multimodal model using Dynamo.
2121
The examples are based on the [llava-1.5-7b-hf](https://huggingface.co/llava-hf/llava-1.5-7b-hf) model.
2222

23+
## Use the Latest Release
24+
25+
We recommend using the latest stable release of dynamo to avoid breaking changes:
26+
27+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
28+
29+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
30+
31+
```bash
32+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
33+
```
34+
2335
## Multimodal Aggregated Serving
2436

2537
### Components

examples/sglang/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ limitations under the License.
1919

2020
This directory contains examples and reference implementations for deploying Large Language Models (LLMs) in various configurations using SGLang. SGLang internally uses ZMQ to communicate between the ingress and the engine processes. For Dynamo, we leverage the runtime to communicate directly with the engine processes and handle ingress and pre/post processing on our end.
2121

22+
## Use the Latest Release
23+
24+
We recommend using the latest stable release of dynamo to avoid breaking changes:
25+
26+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
27+
28+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
29+
30+
```bash
31+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
32+
```
33+
2234
## Deployment Architectures
2335

2436
See [deployment architectures](../llm/README.md#deployment-architectures) to learn about the general idea of the architecture. SGLang currently supports aggregated and disaggregated serving. KV routing support is coming soon!

examples/tensorrt_llm/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ limitations under the License.
1919

2020
This directory contains examples and reference implementations for deploying Large Language Models (LLMs) in various configurations using TensorRT-LLM.
2121

22+
## Use the Latest Release
23+
24+
We recommend using the latest stable release of dynamo to avoid breaking changes:
25+
26+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
27+
28+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
29+
30+
```bash
31+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
32+
```
2233

2334
## Deployment Architectures
2435

examples/vllm_v0/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ limitations under the License.
1919

2020
This directory contains examples for deploying vLLM (v0) models in both aggregated and disaggregated configurations.
2121

22+
## Use the Latest Release
23+
24+
We recommend using the latest stable release of dynamo to avoid breaking changes:
25+
26+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
27+
28+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
29+
30+
```bash
31+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
32+
```
33+
2234
> [!NOTE]
2335
> Different than `/examples/llm`, this example uses `dynamo-run` to handle the (de)tokenization and routing. `dynamo-run` is a rust-based CLI designed for high-performance pre/post-processing and routing. Read more about `dynamo-run`: [dynamo_run.md](../../docs/guides/dynamo_run.md).
2436

examples/vllm_v1/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ limitations under the License.
1919

2020
This directory contains examples for deploying vLLM models in both aggregated and disaggregated configurations.
2121

22+
## Use the Latest Release
23+
24+
We recommend using the latest stable release of dynamo to avoid breaking changes:
25+
26+
[![GitHub Release](https://img.shields.io/github/v/release/ai-dynamo/dynamo)](https://github.com/ai-dynamo/dynamo/releases/latest)
27+
28+
You can find the latest release [here](https://github.com/ai-dynamo/dynamo/releases/latest) and check out the corresponding branch with:
29+
30+
```bash
31+
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
32+
```
33+
2234
## Prerequisites
2335

2436
1. Install vLLM:

0 commit comments

Comments
 (0)