Skip to content

docs: Clean up incomplete recipes and clarify Kubernetes-only focus #4159

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
BenHamm merged 12 commits into from
Nov 18, 2025
Merged

docs: Clean up incomplete recipes and clarify Kubernetes-only focus #4159

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1b34e17
recipes: Clean up incomplete recipes and clarify Kubernetes-only focus
BenHamm Nov 6, 2025
a024413
Remove emojis from README section headings
BenHamm Nov 6, 2025
037c3bd
docs: add hyperlinks to recipe table for easier navigation
BenHamm Nov 6, 2025
85153cd
docs: fix trailing whitespace in README
BenHamm Nov 6, 2025
a6dccf3
restore trtllm configs in examples/trtllm
biswapanda Nov 10, 2025
a6be3b9
Fix the TRTLLM engine config locations and references
tanmayv25 Nov 12, 2025
f1490c4
Fix the multinode documentation
tanmayv25 Nov 12, 2025
5e2646d
Fix the reference directory
tanmayv25 Nov 12, 2025
00c13f3
Apply suggestions from code review
tanmayv25 Nov 13, 2025
0b230f7
Add placeholder for the version
tanmayv25 Nov 13, 2025
85009c5
Update README.md with GAIE
atchernych Nov 17, 2025
f7881a0
Add a new column
tanmayv25 Nov 18, 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
Remove emojis from README section headings 
Address feedback to make the README less AI-generated looking by removing
decorative emojis from section headings while keeping status indicators
(✅ ❌) in tables and content.

Signed-off-by: Ben Hamm <[email protected]>
  • Loading branch information
@BenHamm @tanmayv25
BenHamm authored and tanmayv25 committed Nov 18, 2025
commit a02441313c7a5a62896143d58c4a9870a36c252e
16 changes: 8 additions & 8 deletions recipes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Production-tested Kubernetes deployment recipes for LLM inference using NVIDIA D
> **Prerequisites:** This guide assumes you have already installed the Dynamo Kubernetes Platform.
> If not, follow the **[Kubernetes Deployment Guide](../docs/kubernetes/README.md)** first.

## 📊 Available Recipes
## Available Recipes

| Model | Framework | Mode | GPUs | Deployment | Benchmark Recipe | Notes |
|-------|-----------|------|------|------------|------------------|-------|
Expand All @@ -24,7 +24,7 @@ Production-tested Kubernetes deployment recipes for LLM inference using NVIDIA D
- **Deployment**: ✅ = Complete `deploy.yaml` manifest available | ❌ = Missing or incomplete
- **Benchmark Recipe**: ✅ = Includes `perf.yaml` for running AIPerf benchmarks | ❌ = No benchmark recipe provided

## 📁 Recipe Structure
## Recipe Structure

Each complete recipe follows this standard structure:

Expand All @@ -40,7 +40,7 @@ Each complete recipe follows this standard structure:
└── perf.yaml (optional) # AIPerf benchmark job
```

## 🚀 Quick Start
## Quick Start

### Prerequisites

Expand Down Expand Up @@ -147,7 +147,7 @@ kubectl logs -f job/<benchmark-job-name> -n ${NAMESPACE}
kubectl logs job/<benchmark-job-name> -n ${NAMESPACE} | tail -50
```

## 📖 Example Deployments
## Example Deployments

### Llama-3-70B with vLLM (Aggregated)

Expand All @@ -173,7 +173,7 @@ kubectl port-forward svc/llama3-70b-agg-frontend 8000:8000 -n ${NAMESPACE}

See [deepseek-r1/trtllm/disagg/wide_ep/gb200/deploy.yaml](deepseek-r1/trtllm/disagg/wide_ep/gb200/deploy.yaml) for the complete multi-node WideEP configuration.

## 🛠️ Customization
## Customization

Each `deploy.yaml` contains:
- **ConfigMap**: Engine-specific configuration (embedded in the manifest)
Expand Down Expand Up @@ -220,7 +220,7 @@ image: nvcr.io/nvidia/ai-dynamo/vllm-runtime:0.6.1
# Update version tag as needed
```

## 🔧 Troubleshooting
## Troubleshooting

### Common Issues

Expand All @@ -243,7 +243,7 @@ image: nvcr.io/nvidia/ai-dynamo/vllm-runtime:0.6.1
- [Kubernetes Deployment Guide](../docs/kubernetes/README.md#troubleshooting)
- [Observability Documentation](../docs/kubernetes/observability/)

## 📖 Related Documentation
## Related Documentation

- **[Kubernetes Deployment Guide](../docs/kubernetes/README.md)** - Platform installation and concepts
- **[API Reference](../docs/kubernetes/api_reference.md)** - DynamoGraphDeployment CRD specification
Expand All @@ -253,7 +253,7 @@ image: nvcr.io/nvidia/ai-dynamo/vllm-runtime:0.6.1
- **[Observability](../docs/kubernetes/observability/)** - Monitoring and logging
- **[Benchmarking Guide](../docs/benchmarks/benchmarking.md)** - Performance testing

## 🤝 Contributing
## Contributing

We welcome contributions of new recipes! See [CONTRIBUTING.md](CONTRIBUTING.md) for:
- Recipe submission guidelines
Expand Down