Add vLLM production deployment notes#112
Merged
Merged
Conversation
Extend docs/model-providers/vllm.md with cross-cutting gotchas surfaced in real production work. The "Tool calling" section grows a --tool-call-parser family table (verified against vLLM's docs: Llama 3.x, Llama 4, Mistral, Hermes, Qwen3, DeepSeek V3, GPT-OSS) plus explicit not-supported callouts for Anthropic / Gemini (proprietary cloud) and mainstream Gemma (no parser ships). A new "Production deployment" H2 covers the three gotchas: - VLLM_HTTP_TIMEOUT_KEEP_ALIVE: vLLM's stock 5s uvicorn keep-alive lapses pooled OA-side httpx connections and surfaces as ProviderUnavailable; widen to roughly 300s. Includes the reverse-proxy variant of the same rule. - systemd unit skeleton: structural, no model-specific paths; uses EnvironmentFile so the unit ships across hosts. - Throughput knobs (--max-model-len, --max-num-seqs, --gpu-memory-utilization) framed OA-side: when fan-out concurrency exceeds the cap, expect ProviderRateLimit; wrap the LLM-calling node in RetryMiddleware. Docs-only; no code or test changes. CHANGELOG bullet added under [Unreleased] ### Added.
There was a problem hiding this comment.
Pull request overview
Docs-only PR extending docs/model-providers/vllm.md with a tool-call-parser family table (plus Gemma/Gemini/Qwen3-VL caveats) and a new "Production deployment" section covering keep-alive timeouts, a systemd unit skeleton, and throughput knobs.
Changes:
- Replace single-model parser example with a model-family table and explicit caveats for proprietary/Gemma/Qwen3-VL cases.
- Add a "Production deployment" H2 covering
VLLM_HTTP_TIMEOUT_KEEP_ALIVE, a systemd unit skeleton, and--max-model-len/--max-num-seqs/--gpu-memory-utilizationknobs. - CHANGELOG entry summarizing the additions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/model-providers/vllm.md | Adds parser-family table, model-family caveats, and a production deployment section. |
| CHANGELOG.md | Adds Unreleased Added entry describing the new docs sections. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Second of five docs-polish items. Extends
docs/model-providers/vllm.mdwith cross-cutting gotchas surfaced in real production work.Tool-calling section additions:
--tool-call-parserfamily table verified against vLLM's docs: Llama 3.x (llama3_json), Llama 4 (llama4_pythonic), Mistral (mistral), Hermes / Qwen 2.5 (hermes), Qwen3 / Qwen3-Coder (qwen3_xml), DeepSeek V3 (deepseek_v3), GPT-OSS (openai)New "Production deployment" H2:
VLLM_HTTP_TIMEOUT_KEEP_ALIVE: stock 5s uvicorn keep-alive lapses pooled OA-side httpx connections, surfaces asProviderUnavailable; widen to roughly 300s. Same rule applies behind a reverse proxy.EnvironmentFileso units ship across hosts.--max-model-len,--max-num-seqs,--gpu-memory-utilization) framed OA-side: when fan-outconcurrencyexceeds vLLM's cap, expectProviderRateLimit.retry_after; wrap the LLM-calling node inRetryMiddleware.Docs-only; no code or test changes.
Test plan
uv run pytest -q(1080 pass, no regressions)ruff check+ruff format --checkcleanmkdocs serveand confirm the new sections render correctly under Model Providers → Self-hosted vLLMOut of scope
vllm.md. Falls under item 3's broader docs sweep.