Skip to content

Commit

Permalink
[Doc] add documentation for disaggregated prefilling (vllm-project#11197
Browse files Browse the repository at this point in the history
)

Signed-off-by: Kuntai Du <[email protected]>
  • Loading branch information
KuntaiDu authored Dec 15, 2024
1 parent 96d673e commit 38e599d
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ Documentation
usage/engine_args
usage/env_vars
usage/usage_stats
usage/disagg_prefill

.. toctree::
:maxdepth: 1
Expand Down
69 changes: 69 additions & 0 deletions docs/source/usage/disagg_prefill.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
.. _disagg_prefill:

Disaggregated prefilling (experimental)
=======================================

This page introduces you the disaggregated prefilling feature in vLLM. This feature is experimental and subject to change.

Why disaggregated prefilling?
-----------------------------

Two main reasons:

* **Tuning time-to-first-token (TTFT) and inter-token-latency (ITL) separately**. Disaggregated prefilling put prefill and decode phase of LLM inference inside different vLLM instances. This gives you the flexibility to assign different parallel strategies (e.g. ``tp`` and ``pp``) to tune TTFT without affecting ITL, or to tune ITL without affecting TTFT.
* **Controlling tail ITL**. Without disaggregated prefilling, vLLM may insert some prefill jobs during the decoding of one request. This results in higher tail latency. Disaggregated prefilling helps you solve this issue and control tail ITL. Chunked prefill with a proper chunk size also can achieve the same goal, but in practice it's hard to figure out the correct chunk size value. So disaggregated prefilling is a much more reliable way to control tail ITL.

.. note::
Disaggregated prefill DOES NOT improve throughput.

Usage example
-------------

Please refer to ``examples/disaggregated_prefill.sh`` for the example usage of disaggregated prefilling.


Benchmarks
----------

Please refer to ``benchmarks/disagg_benchmarks/`` for disaggregated prefilling benchmarks.


Development
-----------

We implement disaggregated prefilling by running 2 vLLM instances. One for prefill (we call it prefill instance) and one for decode (we call it decode instance), and then use a connector to transfer the prefill KV caches and results from prefill instance to decode instance.

All disaggregated prefilling implementation is under ``vllm/distributed/kv_transfer``.

Key abstractions for disaggregated prefilling:

* **Connector**: Connector allows **kv consumer** to retrieve the KV caches of a batch of request from **kv producer**.
* **LookupBuffer**: LookupBuffer provides two API: ``insert`` KV cache and ``drop_select`` KV cache. The semantics of ``insert`` and ``drop_select`` are similar to SQL, where ``insert`` inserts a KV cache into the buffer, and ``drop_select`` returns the KV cache that matches the given condition and drop it from the buffer.
* **Pipe**: A single-direction FIFO pipe for tensor transmission. It supports ``send_tensor`` and ``recv_tensor``.

.. note::
``insert`` is non-blocking operation but ``drop_select`` is blocking operation.

Here is a figure illustrating how the above 3 abstractions are organized:

.. image:: /assets/usage/disagg_prefill/abstraction.jpg
:alt: Disaggregated prefilling abstractions

The workflow of disaggregated prefilling is as follows:

.. image:: /assets/usage/disagg_prefill/overview.jpg
:alt: Disaggregated prefilling workflow

The ``buffer`` corresponds to ``insert`` API in LookupBuffer, and the ``drop_select`` corresponds to ``drop_select`` API in LookupBuffer.


Third-party contributions
-------------------------

Disaggregated prefilling is highly related to infrastructure, so vLLM relies on third-party connectors for production-level disaggregated prefilling (and vLLM team will actively review and merge new PRs for third-party connectors).

We recommend three ways of implementations:

* **Fully-customized connector**: Implement your own ``Connector``, and call third-party libraries to send and receive KV caches, and many many more (like editing vLLM's model input to perform customized prefilling, etc). This approach gives you the most control, but at the risk of being incompatible with future vLLM versions.
* **Database-like connector**: Implement your own ``LookupBuffer`` and support the ``insert`` and ``drop_select`` APIs just like SQL.
* **Distributed P2P connector**: Implement your own ``Pipe`` and support the ``send_tensor`` and ``recv_tensor`` APIs, just like `torch.distributed`.

0 comments on commit 38e599d

Please sign in to comment.