File size: 6,457 Bytes
b386992 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | """
This module support timing of code blocks.
"""
# Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import time
from typing import Optional
import numpy as np
import torch
__all__ = ["NamedTimer", "SimpleTimer"]
class NamedTimer(object):
"""
A timer class that supports multiple named timers.
A named timer can be used multiple times, in which case the average
dt will be returned.
A named timer cannot be started if it is already currently running.
Use case: measuring execution of multiple code blocks.
"""
_REDUCTION_TYPE = ["mean", "sum", "min", "max", "none"]
def __init__(self, reduction="mean", sync_cuda=False, buffer_size=-1):
"""
Args:
reduction (str): reduction over multiple timings of the same timer
(none - returns the list instead of a scalar)
sync_cuda (bool): if True torch.cuda.synchronize() is called for start/stop
buffer_size (int): if positive, limits the number of stored measures per name
"""
if reduction not in self._REDUCTION_TYPE:
raise ValueError(f"Unknown reduction={reduction} please use one of {self._REDUCTION_TYPE}")
self._reduction = reduction
self._sync_cuda = sync_cuda
self._buffer_size = buffer_size
self.reset()
def __getitem__(self, k):
return self.get(k)
@property
def buffer_size(self):
return self._buffer_size
@property
def _reduction_fn(self):
if self._reduction == "none":
fn = lambda x: x
else:
fn = getattr(np, self._reduction)
return fn
def reset(self, name=None):
"""
Resents all / specific timer
Args:
name (str): timer name to reset (if None all timers are reset)
"""
if name is None:
self.timers = {}
else:
self.timers[name] = {}
def start(self, name=""):
"""
Starts measuring a named timer.
Args:
name (str): timer name to start
"""
timer_data = self.timers.get(name, {})
if "start" in timer_data:
raise RuntimeError(f"Cannot start timer = '{name}' since it is already active")
# synchronize pytorch cuda execution if supported
if self._sync_cuda and torch.cuda.is_initialized():
torch.cuda.synchronize()
timer_data["start"] = time.time()
self.timers[name] = timer_data
def stop(self, name=""):
"""
Stops measuring a named timer.
Args:
name (str): timer name to stop
"""
timer_data = self.timers.get(name, None)
if (timer_data is None) or ("start" not in timer_data):
raise RuntimeError(f"Cannot end timer = '{name}' since it is not active")
# synchronize pytorch cuda execution if supported
if self._sync_cuda and torch.cuda.is_initialized():
torch.cuda.synchronize()
# compute dt and make timer inactive
dt = time.time() - timer_data.pop("start")
# store dt
timer_data["dt"] = timer_data.get("dt", []) + [dt]
# enforce buffer_size if positive
if self._buffer_size > 0:
timer_data["dt"] = timer_data["dt"][-self._buffer_size :]
self.timers[name] = timer_data
def is_active(self, name=""):
timer_data = self.timers.get(name, {})
if "start" in timer_data:
return True
return False
def active_timers(self):
"""
Return list of all active named timers
"""
return [k for k, v in self.timers.items() if ("start" in v)]
def get(self, name=""):
"""
Returns the value of a named timer
Args:
name (str): timer name to return
"""
dt_list = self.timers[name].get("dt", [])
return self._reduction_fn(dt_list)
def export(self):
"""
Exports a dictionary with average/all dt per named timer
"""
fn = self._reduction_fn
data = {k: fn(v["dt"]) for k, v in self.timers.items() if ("dt" in v)}
return data
class SimpleTimer:
"""
Simple Timer with maximum possible resolution, uses `time.perf_counter_ns`.
"""
def __init__(self, sync_cuda=True):
"""
Args:
sync_cuda: synchronize CUDA device.
The synchronization is done only if the device for start/stop is None or CUDA device.
"""
self.total_time = 0
self._start_time: Optional[int] = None
self.sync_cuda = sync_cuda
def reset(self):
"""Reset timer"""
self.total_time = 0
self._start_time = None
def start(self, device: Optional[torch.device] = None):
"""
Start timer.
Args:
device: CUDA device to synchronize (optional).
"""
if self.sync_cuda and torch.cuda.is_initialized() and (device is None or device.type == "cuda"):
torch.cuda.synchronize(device=device)
if self._start_time is not None:
raise RuntimeError("Timer already started")
self._start_time = time.perf_counter_ns()
def stop(self, device: Optional[torch.device] = None):
"""
Stop device.
Args:
device: CUDA device to synchronize (optional).
"""
if self.sync_cuda and torch.cuda.is_initialized() and (device is None or device.type == "cuda"):
torch.cuda.synchronize(device=device)
if self._start_time is None:
raise RuntimeError("Timer not started")
self.total_time += time.perf_counter_ns() - self._start_time
self._start_time = None
def total_sec(self) -> float:
"""Return total time in seconds"""
return self.total_time / 1e9
|