Class Logger

cdslib/core/utils/print_and_save.py:207–544

Helper class to log information. The class implements a universal logger that can push information to - local shell - tensorboard To support a multi-thread environment, it includes the rank of the current thread in the logging. Usage: .. code-block:: python

class Logger:
    """Helper class to log information.

    The class implements a universal logger that can push information to
    - local shell
    - tensorboard

    To support a multi-thread environment, it includes the rank of the current thread
    in the logging.

    Usage:

        .. code-block:: python

            # create logger
            logger = Logger(
                log_filename=os.path.join('log', f'log_rank{rank}.txt'),
                tensorboard_dir=os.path.join('tensorboard', f'rank{rank}'),
                open_tensorboard=True,
                tensorboard_port=22222,
                rank=rank,
            )

            for iter in range(max_iter):
                # some random scalars
                loss_val1 = 123.
                loss_val2 = 456.

                # log loss
                logger.add_scalars(
                    main_tag='train',
                    tag_scalar_dict={'loss_name1': loss_val1, 'loss_name2': loss_val2},
                    epoch=epoch,
                    batch_idx=batch_idx,
                    global_step=global_step,
                    )

                # remember to flush the logger every iteration
                logger.flush()

            # remember to close the logger
            logger.close()
    """

    def __init__(
            self,
            log_filename=None,
            tensorboard_dir=None,
            tensorboard_num_history_figures=100,
            tensorboard_max_reload_threads=1,
            tensorboard_exe_path="/venv/bin/tensorboard",
            open_tensorboard=False,
            tensorboard_port=22222,
            rank=0,
            launch_tensorboard_at_parent_dir: bool = True,
    ):
        """Create the logger.