A high-throughput and memory-efficient inference and serving engine for LLMs
Mirrored from https://github.com/tduncan-lum/Nvidia-Optimization-Stack---VLLM.git
Synced Nov 4, 03:45 UTC
[Docs] Reorganize examples docs. (#41082)
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
wang.yuqi committed
May 8, 2026 at 14:23 UTC
77b13b9602d32e91d2df71a633e4e3f3c01632ae
1 file changed
+14
-4
docs/examples/README.md
+14
-4
@@ -1,7 +1,17 @@
1
# Examples
2
3
-vLLM's examples are split into three categories:
3
+vLLM's examples are organized into the following categories:
4
5
-- If you are using vLLM from within Python code, see the [Offline Inference](.) section.
6
-- If you are using vLLM from an HTTP application or client, see the [Online Serving](.) section.
7
-- For examples of using some of vLLM's advanced features (e.g. LMCache or Tensorizer) which are not specific to either of the above use cases, see the [Others](.) section.
5
+- **[`basic/`](../../examples/basic)** – Minimal examples for offline inference and online serving.
6
+- **[`generate/`](../../examples/generate)** – Text generation examples, including multimodal models.
7
+- **[`pooling/`](../../examples/pooling)** – Examples for embedding, classification, scoring, reward, etc.
8
+- **[`speech_to_text/`](../../examples/speech_to_text)** – Speech transcription, translation and real-time audio examples.
9
+- **[`features/`](../../examples/features)** – Demonstrations of individual vLLM features: automatic prefix caching, speculative decoding, LoRA, structured outputs, prompt embedding, pause/resume, batch invariance, KV events, data parallelism, and more.
10
+- **[`reasoning/`](../../examples/reasoning)** – Examples for reasoning with vLLM.
11
+- **[`tool_calling/`](../../examples/tool_calling)** – Examples for function/tool calling with vLLM.
12
+- **[`applications/`](../../examples/applications)** – Application examples such as chatbots and RAG (Retrieval-Augmented Generation).
13
+- **[`rl/`](../../examples/rl)** – Reinforcement learning examples.
14
+- **[`deployment/`](../../examples/deployment)** – Examples for deploying vLLM in production.
15
+- **[`ray_serving/`](../../examples/ray_serving)** – Scalable serving using Ray.
16
+- **[`disaggregated/`](../../examples/disaggregated)** – Examples for disaggregated serving (separate prefill and decode), including various kv cache connectors (LMCache, Mooncake, FlexKV, P2P NCCL) and failure recovery.
17
+- **[`observability/`](../../examples/observability)** – Metrics, logging, tracing (OpenTelemetry), and dashboards (Grafana, Perses).