fastreid.utils.events.CommonMetricPrinter Class Reference

Inheritance diagram for fastreid.utils.events.CommonMetricPrinter:

Public Member Functions
	__init__ (self, max_iter)
	write (self)
Public Member Functions inherited from fastreid.utils.events.EventWriter
	close (self)

Public Attributes
	logger

Protected Attributes
	_max_iter
	_last_write

Detailed Description

Print **common** metrics to the terminal, including
iteration time, ETA, memory, all losses, and the learning rate.
It also applies smoothing using a window of 20 elements.
It's meant to print common metrics in common ways.
To print something in more customized ways, please implement a similar printer by yourself.

Definition at line 173 of file events.py.

Constructor & Destructor Documentation

__init__()

fastreid.utils.events.CommonMetricPrinter.__init__	(		self,
			max_iter )

Args:
    max_iter (int): the maximum number of iterations to train.
        Used to compute ETA.

Definition at line 182 of file events.py.

    def __init__(self, max_iter):
        """
        Args:
            max_iter (int): the maximum number of iterations to train.
                Used to compute ETA.
        """
        self.logger = logging.getLogger(__name__)
        self._max_iter = max_iter
        self._last_write = None
 

Member Function Documentation

write()

fastreid.utils.events.CommonMetricPrinter.write

(

self

)

Reimplemented from fastreid.utils.events.EventWriter.

Definition at line 192 of file events.py.

    def write(self):
        storage = get_event_storage()
        iteration = storage.iter
 
        try:
            data_time = storage.history("data_time").avg(20)
        except KeyError:
            # they may not exist in the first few iterations (due to warmup)
            # or when SimpleTrainer is not used
            data_time = None
 
        eta_string = None
        try:
            iter_time = storage.history("time").global_avg()
            eta_seconds = storage.history("time").median(1000) * (self._max_iter - iteration)
            storage.put_scalar("eta_seconds", eta_seconds, smoothing_hint=False)
            eta_string = str(datetime.timedelta(seconds=int(eta_seconds)))
        except KeyError:
            iter_time = None
            # estimate eta on our own - more noisy
            if self._last_write is not None:
                estimate_iter_time = (time.perf_counter() - self._last_write[1]) / (
                    iteration - self._last_write[0]
                )
                eta_seconds = estimate_iter_time * (self._max_iter - iteration)
                eta_string = str(datetime.timedelta(seconds=int(eta_seconds)))
            self._last_write = (iteration, time.perf_counter())
 
        try:
            lr = "{:.2e}".format(storage.history("lr").latest())
        except KeyError:
            lr = "N/A"
 
        if torch.cuda.is_available():
            max_mem_mb = torch.cuda.max_memory_allocated() / 1024.0 / 1024.0
        else:
            max_mem_mb = None
 
        # NOTE: max_mem is parsed by grep in "dev/parse_results.sh"
        self.logger.info(
            " {eta}iter: {iter}  {losses}  {time}{data_time}lr: {lr}  {memory}".format(
                eta=f"eta: {eta_string}  " if eta_string else "",
                iter=iteration,
                losses="  ".join(
                    [
                        "{}: {:.4g}".format(k, v.median(20))
                        for k, v in storage.histories().items()
                        if "loss" in k
                    ]
                ),
                time="time: {:.4f}  ".format(iter_time) if iter_time is not None else "",
                data_time="data_time: {:.4f}  ".format(data_time) if data_time is not None else "",
                lr=lr,
                memory="max_mem: {:.0f}M".format(max_mem_mb) if max_mem_mb is not None else "",
            )
        )
 
 

Member Data Documentation

_last_write

fastreid.utils.events.CommonMetricPrinter._last_write

protected

Definition at line 190 of file events.py.

_max_iter

fastreid.utils.events.CommonMetricPrinter._max_iter

protected

Definition at line 189 of file events.py.

logger

fastreid.utils.events.CommonMetricPrinter.logger

Definition at line 188 of file events.py.

---

The documentation for this class was generated from the following file:

• smreid/fastreid/utils/events.py