Track a series of scalar values and provide access to smoothed values over a
window or the global average of the series.
Definition at line 8 of file history_buffer.py.
◆ __init__()
| fastreid.utils.history_buffer.HistoryBuffer.__init__ |
( |
| self, |
|
|
int | max_length = 1000000 ) |
Args:
max_length: maximal number of values that can be stored in the
buffer. When the capacity of the buffer is exhausted, old
values will be removed.
Definition at line 14 of file history_buffer.py.
14 def __init__(self, max_length: int = 1000000):
15 """
16 Args:
17 max_length: maximal number of values that can be stored in the
18 buffer. When the capacity of the buffer is exhausted, old
19 values will be removed.
20 """
21 self._max_length: int = max_length
22 self._data: List[Tuple[float, float]] = []
23 self._count: int = 0
24 self._global_avg: float = 0
25
◆ avg()
| fastreid.utils.history_buffer.HistoryBuffer.avg |
( |
| self, |
|
|
int | window_size ) |
Return the mean of the latest `window_size` values in the buffer.
Definition at line 53 of file history_buffer.py.
53 def avg(self, window_size: int):
54 """
55 Return the mean of the latest `window_size` values in the buffer.
56 """
57 return np.mean([x[0] for x in self._data[-window_size:]])
58
◆ global_avg()
| fastreid.utils.history_buffer.HistoryBuffer.global_avg |
( |
| self | ) |
|
Return the mean of all the elements in the buffer. Note that this
includes those getting removed due to limited buffer storage.
Definition at line 59 of file history_buffer.py.
59 def global_avg(self):
60 """
61 Return the mean of all the elements in the buffer. Note that this
62 includes those getting removed due to limited buffer storage.
63 """
64 return self._global_avg
65
◆ latest()
| fastreid.utils.history_buffer.HistoryBuffer.latest |
( |
| self | ) |
|
Return the latest scalar value added to the buffer.
Definition at line 41 of file history_buffer.py.
41 def latest(self):
42 """
43 Return the latest scalar value added to the buffer.
44 """
45 return self._data[-1][0]
46
◆ median()
| fastreid.utils.history_buffer.HistoryBuffer.median |
( |
| self, |
|
|
int | window_size ) |
Return the median of the latest `window_size` values in the buffer.
Definition at line 47 of file history_buffer.py.
47 def median(self, window_size: int):
48 """
49 Return the median of the latest `window_size` values in the buffer.
50 """
51 return np.median([x[0] for x in self._data[-window_size:]])
52
◆ update()
| fastreid.utils.history_buffer.HistoryBuffer.update |
( |
| self, |
|
|
float | value, |
|
|
float | iteration = None ) |
Add a new scalar value produced at certain iteration. If the length
of the buffer exceeds self._max_length, the oldest element will be
removed from the buffer.
Definition at line 26 of file history_buffer.py.
26 def update(self, value: float, iteration: float = None):
27 """
28 Add a new scalar value produced at certain iteration. If the length
29 of the buffer exceeds self._max_length, the oldest element will be
30 removed from the buffer.
31 """
32 if iteration is None:
33 iteration = self._count
34 if len(self._data) == self._max_length:
35 self._data.pop(0)
36 self._data.append((value, iteration))
37
38 self._count += 1
39 self._global_avg += (value - self._global_avg) / self._count
40
◆ values()
| fastreid.utils.history_buffer.HistoryBuffer.values |
( |
| self | ) |
|
Returns:
list[(number, iteration)]: content of the current buffer.
Definition at line 66 of file history_buffer.py.
66 def values(self):
67 """
68 Returns:
69 list[(number, iteration)]: content of the current buffer.
70 """
71 return self._data
◆ _data
| fastreid.utils.history_buffer.HistoryBuffer._data |
|
protected |
The documentation for this class was generated from the following file:
