Source code for catalyst.utils.meters.meter

[docs]class Meter(object):
    """Meters provide a way to keep track of important statistics in an online
    manner.

    This class is abstract, but provides a standard interface for all meters to
    follow.

    """


[docs]    def reset(self):
        """Resets the meter to default settings."""
        pass



[docs]    def add(self, value):
        """Log a new value to the meter

        Args:
            value: Next restult to include.

        """
        pass



[docs]    def value(self):
        """Get the value of the meter in the current state."""
        pass