-
Notifications
You must be signed in to change notification settings - Fork 387
/
running.py
183 lines (155 loc) · 8.1 KB
/
running.py
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
# Copyright The Lightning team.
#
# 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.
from typing import Any, Optional, Sequence, Union
from torch import Tensor
from torchmetrics.metric import Metric
from torchmetrics.utilities.imports import _MATPLOTLIB_AVAILABLE
from torchmetrics.utilities.plot import _AX_TYPE, _PLOT_OUT_TYPE
from torchmetrics.wrappers.abstract import WrapperMetric
if not _MATPLOTLIB_AVAILABLE:
__doctest_skip__ = ["Running.plot"]
class Running(WrapperMetric):
"""Running wrapper for metrics.
Using this wrapper allows for calculating metrics over a running window of values, instead of the whole history of
values. This is beneficial when you want to get a better estimate of the metric during training and don't want to
wait for the whole training to finish to get epoch level estimates.
The running window is defined by the `window` argument. The window is a fixed size and this wrapper will store a
duplicate of the underlying metric state for each value in the window. Thus memory usage will increase linearly
with window size. Use accordingly. Also note that the running only works with metrics that have the
`full_state_update` set to `False`.
Importantly, the wrapper does not alter the value of the `forward` method of the underlying metric. Thus, forward
will still return the value on the current batch. To get the running value call `compute` instead.
Args:
base_metric: The metric to wrap.
window: The size of the running window.
Example:
# Single metric
>>> from torch import tensor
>>> from torchmetrics.wrappers import Running
>>> from torchmetrics.aggregation import SumMetric
>>> metric = Running(SumMetric(), window=3)
>>> for i in range(6):
... current_val = metric(tensor([i]))
... running_val = metric.compute()
... total_val = tensor(sum(list(range(i+1)))) # value we would get from `compute` without running
... print(f"{current_val=}, {running_val=}, {total_val=}")
current_val=tensor(0.), running_val=tensor(0.), total_val=tensor(0)
current_val=tensor(1.), running_val=tensor(1.), total_val=tensor(1)
current_val=tensor(2.), running_val=tensor(3.), total_val=tensor(3)
current_val=tensor(3.), running_val=tensor(6.), total_val=tensor(6)
current_val=tensor(4.), running_val=tensor(9.), total_val=tensor(10)
current_val=tensor(5.), running_val=tensor(12.), total_val=tensor(15)
Example:
# Metric collection
>>> from torch import tensor
>>> from torchmetrics.wrappers import Running
>>> from torchmetrics import MetricCollection
>>> from torchmetrics.aggregation import SumMetric, MeanMetric
>>> # note that running is input to collection, not the other way
>>> metric = MetricCollection({"sum": Running(SumMetric(), 3), "mean": Running(MeanMetric(), 3)})
>>> for i in range(6):
... current_val = metric(tensor([i]))
... running_val = metric.compute()
... print(f"{current_val=}, {running_val=}")
current_val={'mean': tensor(0.), 'sum': tensor(0.)}, running_val={'mean': tensor(0.), 'sum': tensor(0.)}
current_val={'mean': tensor(1.), 'sum': tensor(1.)}, running_val={'mean': tensor(0.5000), 'sum': tensor(1.)}
current_val={'mean': tensor(2.), 'sum': tensor(2.)}, running_val={'mean': tensor(1.), 'sum': tensor(3.)}
current_val={'mean': tensor(3.), 'sum': tensor(3.)}, running_val={'mean': tensor(2.), 'sum': tensor(6.)}
current_val={'mean': tensor(4.), 'sum': tensor(4.)}, running_val={'mean': tensor(3.), 'sum': tensor(9.)}
current_val={'mean': tensor(5.), 'sum': tensor(5.)}, running_val={'mean': tensor(4.), 'sum': tensor(12.)}
"""
def __init__(self, base_metric: Metric, window: int = 5) -> None:
super().__init__()
if not isinstance(base_metric, Metric):
raise ValueError(
f"Expected argument `metric` to be an instance of `torchmetrics.Metric` but got {base_metric}"
)
if not (isinstance(window, int) and window > 0):
raise ValueError(f"Expected argument `window` to be a positive integer but got {window}")
self.base_metric = base_metric
self.window = window
if base_metric.full_state_update is not False:
raise ValueError(
f"Expected attribute `full_state_update` set to `False` but got {base_metric.full_state_update}"
)
self._num_vals_seen = 0
for key in base_metric._defaults:
for i in range(window):
self.add_state(
name=key + f"_{i}", default=base_metric._defaults[key], dist_reduce_fx=base_metric._reductions[key]
)
def update(self, *args: Any, **kwargs: Any) -> None:
"""Update the underlying metric and save state afterwards."""
val = self._num_vals_seen % self.window
self.base_metric.update(*args, **kwargs)
for key in self.base_metric._defaults:
setattr(self, key + f"_{val}", getattr(self.base_metric, key))
self.base_metric.reset()
self._num_vals_seen += 1
def forward(self, *args: Any, **kwargs: Any) -> Any:
"""Forward input to the underlying metric and save state afterwards."""
val = self._num_vals_seen % self.window
res = self.base_metric.forward(*args, **kwargs)
for key in self.base_metric._defaults:
setattr(self, key + f"_{val}", getattr(self.base_metric, key))
self.base_metric.reset()
self._num_vals_seen += 1
self._computed = None
return res
def compute(self) -> Any:
"""Compute the metric over the running window."""
for i in range(self.window):
self.base_metric._reduce_states({key: getattr(self, key + f"_{i}") for key in self.base_metric._defaults})
val = self.base_metric.compute()
self.base_metric.reset()
return val
def reset(self) -> None:
"""Reset metric."""
super().reset()
self._num_vals_seen = 0
def plot(
self, val: Optional[Union[Tensor, Sequence[Tensor]]] = None, ax: Optional[_AX_TYPE] = None
) -> _PLOT_OUT_TYPE:
"""Plot a single or multiple values from the metric.
Args:
val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
If no value is provided, will automatically call `metric.compute` and plot that result.
ax: An matplotlib axis object. If provided will add plot to that axis
Returns:
Figure and Axes object
Raises:
ModuleNotFoundError:
If `matplotlib` is not installed
.. plot::
:scale: 75
>>> # Example plotting a single value
>>> import torch
>>> from torchmetrics.wrappers import Running
>>> from torchmetrics.aggregation import SumMetric
>>> metric = Running(SumMetric(), 2)
>>> metric.update(torch.randn(20, 2))
>>> fig_, ax_ = metric.plot()
.. plot::
:scale: 75
>>> # Example plotting multiple values
>>> import torch
>>> from torchmetrics.wrappers import Running
>>> from torchmetrics.aggregation import SumMetric
>>> metric = Running(SumMetric(), 2)
>>> values = [ ]
>>> for _ in range(3):
... values.append(metric(torch.randn(20, 2)))
>>> fig_, ax_ = metric.plot(values)
"""
return self._plot(val, ax)