Skip to content

Commit

Permalink
Doc: Improve benchmark documentation (vllm-project#9927)
Browse files Browse the repository at this point in the history
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Maxime Fournioux <[email protected]>
  • Loading branch information
rafvasq authored and mfournioux committed Nov 20, 2024
1 parent e979949 commit c74c584
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 27 deletions.
5 changes: 3 additions & 2 deletions docs/source/dev/profiling/profiling_index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Profiling vLLM
=================================
==============
Profiling vLLM
==============

We support tracing vLLM workers using the ``torch.profiler`` module. You can enable tracing by setting the ``VLLM_TORCH_PROFILER_DIR`` environment variable to the directory where you want to save the traces: ``VLLM_TORCH_PROFILER_DIR=/mnt/traces/``

Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ Documentation

.. toctree::
:maxdepth: 1
:caption: Performance benchmarks
:caption: Performance

performance_benchmark/benchmarks
performance/benchmarks

.. toctree::
:maxdepth: 2
Expand Down
33 changes: 33 additions & 0 deletions docs/source/performance/benchmarks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. _benchmarks:

================
Benchmark Suites
================

vLLM contains two sets of benchmarks:

+ :ref:`Performance benchmarks <performance_benchmarks>`
+ :ref:`Nightly benchmarks <nightly_benchmarks>`


.. _performance_benchmarks:

Performance Benchmarks
----------------------

The performance benchmarks are used for development to confirm whether new changes improve performance under various workloads. They are triggered on every commit with both the ``perf-benchmarks`` and ``ready`` labels, and when a PR is merged into vLLM.

The latest performance results are hosted on the public `vLLM Performance Dashboard <https://perf.vllm.ai>`_.

More information on the performance benchmarks and their parameters can be found `here <https://github.com/vllm-project/vllm/blob/main/.buildkite/nightly-benchmarks/performance-benchmarks-descriptions.md>`__.

.. _nightly_benchmarks:

Nightly Benchmarks
------------------

These compare vLLM's performance against alternatives (``tgi``, ``trt-llm``, and ``lmdeploy``) when there are major updates of vLLM (e.g., bumping up to a new version). They are primarily intended for consumers to evaluate when to choose vLLM over other options and are triggered on every commit with both the ``perf-benchmarks`` and ``nightly-benchmarks`` labels.

The latest nightly benchmark results are shared in major release blog posts such as `vLLM v0.6.0 <https://blog.vllm.ai/2024/09/05/perf-update.html>`_.

More information on the nightly benchmarks and their parameters can be found `here <https://github.com/vllm-project/vllm/blob/main/.buildkite/nightly-benchmarks/nightly-descriptions.md>`__.
23 changes: 0 additions & 23 deletions docs/source/performance_benchmark/benchmarks.rst

This file was deleted.

0 comments on commit c74c584

Please sign in to comment.