Skip to content

Abstract Base Classes

ExperimentAggregator

The abstract base class for experiment aggregation methods.

Properties should be implemented as class attributes in derived metrics

The compute_metric method needs to be implemented

Attributes

full_name abstractmethod instance-attribute property

A human-readable name for this experiment-aggregation method.

aliases abstractmethod instance-attribute property

A list of all valid aliases for this metric. Can be used in configuration files.

name property

The name of the experiment aggregation method.

Functions

aggregate abstractmethod

Aggregates samples from many experiments.

Parameters:

  • experiment_samples (Float[array, 'num_samples num_experiments']) –

    the samples from the individual experiments

  • bounds (tuple[float, float]) –

    the maximum and minimum possible value that the samples might take

Returns:

  • Float[ndarray, ' num_experiments'] –

    Float[nd.array, "num_samples num_experiments"]: samples from the aggregate distribution

__call__

Aggregates a series of experiment results from a specific ExperimentGroup and Metric.