utils.log_helper

log_helper

Please Reference ding/ding/utils/log_helper.py for usage.

build_logger

Overview:

Build text logger and tensorboard logger.

Arguments:

  • path (str): Logger(Textlogger & SummaryWriter)’s saved dir

  • name (str): The logger file name

  • need_tb (bool): Whether SummaryWriter instance would be created and returned

  • need_text (bool): Whether loggingLogger instance would be created and returned

  • text_level (int` or str): Logging level of logging.Logger, default set to logging.INFO

Returns:

  • logger (Optional[logging.Logger]): Logger that displays terminal output

  • tb_logger (Optional['SummaryWriter']): Saves output to tfboard, only return when need_tb.

LoggerFactory

ding.utils.log_helper.LoggerFactory.create_logger(path: str, name: str = 'default', level: Union[int, str] = 20) → logging.Logger
Overview:

Create logger using logging

Arguments:

  • name (str): Logger’s name

  • path (str): Logger’s save dir

  • level (int or str): Used to set the level. Reference: Logger.setLevel method.

Returns:

  • (logging.Logger): new logging logger

ding.utils.log_helper.LoggerFactory.get_tabulate_vars(variables: Dict[str, Any]) → str
Overview:

Get the text description in tabular form of all vars

Arguments:

  • variables (List[str]): Names of the vars to query.

Returns:

  • string (str): Text description in tabular form of all vars

DistributionTimeImage

pretty_print

Overview:

Print a dict result in a pretty way

Arguments:

  • result (dict): The result to print

  • direct_print (bool): Whether to print directly

Returns:

  • string (str): The pretty-printed result in str format