Class VisdomTextLogger

project_utils/visualization_utils.py:1056–1146

Creates a text window in visdom and logs output to it. The output can be formatted with fancy HTML, and it new output can be set to 'append' or 'replace' mode. Args: fields: Currently not used update_type: One of {'REPLACE', 'APPEND'}. Default 'REPLACE'. For exampl

class VisdomTextLogger(BaseVisdomLogger):
    '''Creates a text window in visdom and logs output to it.

    The output can be formatted with fancy HTML, and it new output can
    be set to 'append' or 'replace' mode.

    Args:
        fields: Currently not used
        update_type: One of {'REPLACE', 'APPEND'}. Default 'REPLACE'.

    For examples, make sure that your visdom server is running.

    Example:
        >>> notes_logger = VisdomTextLogger(update_type='APPEND')
        >>> for i in range(10):
        >>>     notes_logger.log("Printing: {} of {}".format(i+1, 10))
        # results will be in Visdom environment (default: http://localhost:8097)

    '''
    valid_update_types = ['REPLACE', 'APPEND']

    def __init__(self, fields=None, win=None, env=None, opts={}, update_type=valid_update_types[0],
                 port=8097, server="localhost"):

        super(VisdomTextLogger, self).__init__(fields, win, env, opts, port, server)
        self.text = ''

        if update_type not in self.valid_update_types:
            raise ValueError("update type '{}' not found. Must be one of {}".format(
                update_type, self.valid_update_types))
        self.update_type = update_type

        self.viz_logger = self._viz_prototype(self.viz.text)

    def log(self, msg, *args, **kwargs):
        text = msg
        if self.update_type == 'APPEND' and self.text:
            self.text = "<br>".join([self.text, text])
        else:
            self.text = text
        self.viz_logger([self.text])

    def _log_all(self, stats, log_fields, prefix=None, suffix=None, require_dict=False):
        results = []
        for field_idx, field in enumerate(self.fields):
            parent, stat = None, stats
            for f in field:
                parent, stat = stat, stat[f]
            name, output = self._gather_outputs(field, log_fields,
                                                parent, stat, require_dict)
            if not output:
                continue
            self._align_output(field_idx, output)
            results.append((name, output))
        if not results:
            return
        output = self._join_results(results)
        if prefix is not None: