[Easy] Update record_function Comment (#130561)

sraikund16 · pytorchmergebot · commit b5b91b418da0 · 2024-07-11T23:51:25.000Z
Summary: Users have been confused why user annotations on GPU tracks do not show when doing GPU only tracing. This comment should help users understand that to use this function they need to have CPU activies enabled. Test Plan: N/A it is just updating a comment Differential Revision: D59649390 Pull Request resolved: #130561 Approved by: https://github.com/aaronenyeshi
diff --git a/torch/autograd/profiler.py b/torch/autograd/profiler.py
@@ -639,6 +639,7 @@ def createFunctionEventForMemoryEvents(evt):
 
 class record_function(_ContextDecorator):
     """Context manager/function decorator that adds a label to a code block/function when running autograd profiler.
+    Label will only appear if CPU activity tracing is enabled.
 
     It is useful when tracing the code profile.
 
