Summarizers

The summarizer classes contains the functions to calculate a summary value for the given time series.

BuiltInSummarizer

class performance.driver.core.classes.summarizer.BuiltInSummarizer(config)

A proxy class that calls the built-in summarizer functions

# Can be used without configuration, like so:
metrics:
  - name: metric
    ...
    summarize: [mean, min, ]

# Or with configuration like so:
metrics:
  - name: metric
    ...
    summarize:
      - class @mean

        # The name of the metric in the plots
        name: mean

        # [Optional] Set to `yes` to include outliers
        outliers: no

The following built-in summarizers are available:

• mean : Calculate the mean value of the timeseries
• mean_err : Calculate the mean value, including statistical errors
• min : Find the minimum value
• max : Find the maximum value
• sum : Calculate the sum of all timeseries
• median : Calculate the median of the timeseries
• mode : Calculate the mode of the timeseries
• variance : Calculate the variance of the timeseries
• sdeviation : Calculate the standard deviation of the timeseries