backend-readme.md 1.7 KB
Newer Older
1
2
3
---
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
4
title: Backend README
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
---

{/* 2-3 sentence overview of this backend integration */}

## Feature Matrix

{/* Copy actual feature matrix from existing backend docs */}
{/* Example pattern (from vLLM README): */}

| Feature | Status | Notes |
|---------|--------|-------|
| Disaggregated Serving | ✅ | |
| KV-Aware Routing | ✅ | |
| SLA-Based Planner | ✅ | |
| Multimodal | ✅ | Vision models |
| LoRA | 🚧 | Experimental |

## Quick Start

### Prerequisites

- {/* List prerequisites */}

### Usage

```bash
# Add minimal usage example from existing backend docs
# Example pattern (vLLM):
# python -m dynamo.vllm --model <model-name>
# Example pattern (SGLang):
# python -m dynamo.sglang --model <model-name>
```

### Kubernetes

```yaml
41
# Add DGDR example - use apiVersion: nvidia.com/v1beta1
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# See recipes/ folder for production examples
```

## Configuration

| Parameter | Default | Description |
|-----------|---------|-------------|
| {/* param */} | {/* default */} | {/* description */} |

{/* EXAMPLE: Filled-in Configuration for vLLM would look like:

| Parameter | Default | Description |
|-----------|---------|-------------|
| `--model` | required | Model path or HuggingFace ID |
| `--tensor-parallel-size` | `1` | Number of GPUs for tensor parallelism |
| `--max-model-len` | auto | Maximum sequence length | */}

## Next Steps

| Document | Path | Description |
|----------|------|-------------|
| `<Backend> Guide` | `<backend>_guide.md` | Advanced configuration |
| Backend Comparison | `../README.md` | Compare backends |

{/* Convert table rows to markdown links */}