diff --git a/docs/source/performance/benchmarks.rst b/docs/source/performance/benchmarks.rst index e5c8d6a55de63..6d4d7b544cb5d 100644 --- a/docs/source/performance/benchmarks.rst +++ b/docs/source/performance/benchmarks.rst @@ -1,23 +1,33 @@ .. _benchmarks: -Benchmark suites of vLLM -======================== +================ +Benchmark Suites +================ +vLLM contains two sets of benchmarks: ++ :ref:`Performance benchmarks ` ++ :ref:`Nightly benchmarks ` -vLLM contains two sets of benchmarks: -+ **Performance benchmarks**: benchmark vLLM's performance under various workloads at a high frequency (when a pull request (PR for short) of vLLM is being merged). See `vLLM performance dashboard `_ for the latest performance results. +.. _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. -+ **Nightly benchmarks**: 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). The latest results are available in the `vLLM GitHub README `_. +The latest performance results are hosted on the public `vLLM Performance Dashboard `_. +More information on the performance benchmarks and their parameters can be found `here `__. -Trigger a benchmark -------------------- +.. _nightly_benchmarks: -The performance benchmarks and nightly benchmarks can be triggered by submitting a PR to vLLM, and label the PR with `perf-benchmarks` and `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. -.. note:: +The latest nightly benchmark results are shared in major release blog posts such as `vLLM v0.6.0 `_. - Please refer to `vLLM performance benchmark descriptions `_ and `vLLM nightly benchmark descriptions `_ for detailed descriptions on benchmark environment, workload and metrics. +More information on the nightly benchmarks and their parameters can be found `here `__. \ No newline at end of file