diff --git a/docs/contributing/profiling.md b/docs/contributing/profiling.md index ce10adaf0..e4bb0b696 100644 --- a/docs/contributing/profiling.md +++ b/docs/contributing/profiling.md @@ -5,8 +5,12 @@ ## Profile with PyTorch Profiler -We support tracing vLLM workers using the `torch.profiler` module. You can enable the torch profiler by setting `--profiler-config` -when launching the server, and setting the entries `profiler` to `'torch'` and `torch_profiler_dir` to the directory where you want to save the traces. Additionally, you can control the profiling content by specifying the following additional arguments in the config: +We support tracing vLLM workers using different profilers. You can enable profiling by setting the `--profiler-config` flag when launching the server. + +!!! note + The `--profiler-config` flag is available in vLLM v0.13.0 and later. If you are using an earlier version, please upgrade to use this feature. + +To use the `torch.profiler` module, set the `profiler` entry to `'torch'` and `torch_profiler_dir` to the directory where you want to save the traces. Additionally, you can control the profiling content by specifying the following additional arguments in the config: - `torch_profiler_record_shapes` to enable recording Tensor Shapes, off by default - `torch_profiler_with_memory` to record memory, off by default