diff --git a/docs/contributing/profiling.md b/docs/contributing/profiling.md index 1d12d63549a0..addda300d020 100644 --- a/docs/contributing/profiling.md +++ b/docs/contributing/profiling.md @@ -206,8 +206,8 @@ Both the `vllm.utils.profiling.cprofile` and `vllm.utils.profiling.cprofile_cont used to profile a section of code. !!! note - The legacy import paths `vllm.utils.cprofile` and `vllm.utils.cprofile_context` are deprecated. - Please use `vllm.utils.profiling.cprofile` and `vllm.utils.profiling.cprofile_context` instead. + The `vllm.utils.profiling` helpers are deprecated and will be removed in + `v0.21`. Please use Python's `cProfile` module directly instead. ### Example usage - decorator diff --git a/vllm/utils/profiling.py b/vllm/utils/profiling.py index b66910693957..ce2a5ba3993a 100644 --- a/vllm/utils/profiling.py +++ b/vllm/utils/profiling.py @@ -8,7 +8,13 @@ from functools import wraps from typing import Any +from typing_extensions import deprecated + +@deprecated( + "vllm.utils.profiling.cprofile_context() is deprecated and will be removed " + "in v0.21. Use Python's cProfile module directly instead." +) @contextlib.contextmanager def cprofile_context(save_file: str | None = None): """Run a cprofile @@ -32,6 +38,10 @@ def cprofile_context(save_file: str | None = None): prof.print_stats(sort="cumtime") +@deprecated( + "vllm.utils.profiling.cprofile() is deprecated and will be removed in " + "v0.21. Use Python's cProfile module directly instead." +) def cprofile(save_file: str | None = None, enabled: bool = True): """Decorator to profile a Python method using cProfile.