[UX] improve profiler error message (#31125)

Signed-off-by: Boyuan Feng <boyuan@meta.com>
This commit is contained in:
Boyuan Feng 2025-12-22 08:45:59 -08:00 committed by GitHub
parent 022f3cea53
commit 8dd0db687b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -634,7 +634,12 @@ class Worker(WorkerBase):
def profile(self, is_start: bool = True):
if self.profiler is None:
raise RuntimeError("Profiling is not enabled.")
raise RuntimeError(
"Profiling is not enabled. Please set --profiler-config to enable "
"profiling. Example: "
"'--profiler-config.profiler=torch --profiler-config.torch_profiler_dir"
"=YOUR_DIR_PATH_TO_DUMP_TRACE'"
)
if is_start:
self.profiler.start()
else: