Shortcuts

TimeCounter

class mmengine.utils.dl_utils.TimeCounter(log_interval=1, warmup_interval=1, with_sync=True, tag=None, logger=None)[source]

A tool that counts the average running time of a function or a method. Users can use it as a decorator or context manager to calculate the average running time of code blocks.

Parameters:
  • log_interval (int) – The interval of logging. Defaults to 1.

  • warmup_interval (int) – The interval of warmup. Defaults to 1.

  • with_sync (bool) – Whether to synchronize cuda. Defaults to True.

  • tag (str, optional) – Function tag. Used to distinguish between different functions or methods being called. Defaults to None.

  • logger (MMLogger, optional) – Formatted logger used to record messages. Defaults to None.

Examples

>>> import time
>>> from mmengine.utils.dl_utils import TimeCounter
>>> @TimeCounter()
... def fun1():
...     time.sleep(0.1)
... fun1()
[fun1]-time per run averaged in the past 1 runs: 100.0 ms
>>> @@TimeCounter(log_interval=2, tag='fun')
... def fun2():
...    time.sleep(0.2)
>>> for _ in range(3):
...    fun2()
[fun]-time per run averaged in the past 2 runs: 200.0 ms
>>> with TimeCounter(tag='fun3'):
...      time.sleep(0.3)
[fun3]-time per run averaged in the past 1 runs: 300.0 ms
print_time(elapsed)[source]

print times per count.

Parameters:

elapsed (int | float) –

Return type:

None

Read the Docs v: v0.10.4
Versions
latest
stable
v0.10.4
v0.10.3
v0.10.2
v0.10.1
v0.10.0
v0.9.1
v0.9.0
v0.8.5
v0.8.4
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.4
v0.7.3
v0.7.2
v0.7.1
v0.7.0
v0.6.0
v0.5.0
v0.4.0
v0.3.0
v0.2.0
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.