From 6dd6d078134b76c3b15efa5a737642aa69a08a01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=84=E5=A9=B7?= Date: Wed, 12 Jul 2023 19:48:04 +0800 Subject: [PATCH] feat(utils/writer.py): add class comment --- internlm/utils/writer.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/internlm/utils/writer.py b/internlm/utils/writer.py index 16514c7..9aaf750 100644 --- a/internlm/utils/writer.py +++ b/internlm/utils/writer.py @@ -95,13 +95,19 @@ class Writer: Customed writer based on tensorboard for recording training metrics. Args: + launch_time (str): A string representing the launch time of the training. + tensorboard_folder (str): A string representing the folder for saving tensorboard logs. + resume_tb_folder (str): A string representing the folder for resuming tensorboard logs. + step_count (int): An integer representing the step count of the training. + config (str): A string representing the configuration of the training. + logger (logging.Logger): A logging.Logger object for logging information during training. + enable_tb (bool): A boolean indicating whether to enable the tensorboard writer. - Return: """ def __init__( self, - launch_time, + launch_time: str, tensorboard_folder: str = None, resume_tb_folder: str = None, step_count: int = 0,