from pysad.core.base_statistic import UnivariateStatistic
[docs]class AverageMeter(UnivariateStatistic):
"""The average of the values.
Attrs:
sum (float): The summation of values.
num_items (int): The number of items that are used to update the statistic.
"""
def __init__(self):
self.sum = 0.0
self.num_items = 0
[docs] def update(self, num):
"""Updates the statistic with the value for a timestep.
Args:
num (float): The incoming value, for which the statistic is used.
Returns:
object: self.
"""
self.sum += num
self.num_items += 1
return self
[docs] def remove(self, num):
"""Updates the statistic by removing particular value. This method
Args:
num (float): The value to be removed.
Returns:
object: self.
"""
self.sum -= num
self.num_items -= 1
return self
[docs] def get(self):
""" Method to obtain the tracked statistic.
Returns:
float: The statistic.
"""
return self.sum / self.num_items