Skip to content

Commit aa7af5f

Browse files
FindHaofacebook-github-bot
authored andcommitted
Update init function documentation in structured_logging.py (#35)
Summary: Update init function documentation in structured_logging.py to clarify parameter usage - Corrected the comment in the `init` function to specify that it sets up the compilation listener. - Added a description for the new `enable_trace_launch` parameter in the function's docstring. These changes enhance the clarity of the function's purpose and parameters, improving code maintainability. Pull Request resolved: #35 Reviewed By: Sibylau Differential Revision: D78563516 Pulled By: FindHao fbshipit-source-id: f4c176ecae4894d7dfa76a942b68a1c8a30d1fbf
1 parent acdac2c commit aa7af5f

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

tritonparse/structured_logging.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -983,10 +983,11 @@ def init_basic(trace_folder: Optional[str] = None):
983983

984984
def init(trace_folder: Optional[str] = None, enable_trace_launch: bool = False):
985985
"""
986-
This function is a wrapper around init_basic() that also setup the compilation listener.
986+
This function is a wrapper around init_basic() that also sets up the compilation listener.
987987
988988
Args:
989989
trace_folder (Optional[str]): The folder to store the trace files.
990+
enable_trace_launch (bool): Whether to enable the trace launch hook.
990991
"""
991992
global TRITON_TRACE_LAUNCH
992993
if enable_trace_launch:

0 commit comments

Comments
 (0)