Comparator

class hypex.comparators.Comparator(compare_by, grouping_role=None, target_roles=None, baseline_role=None, key='', calc_kwargs={})[source]

Bases: Calculator, ABC

execute(data)[source]

Execute the comparator on the given data.

The comparator will split the data into a baseline and a comparison dataset based on the compare_by argument. Then it will calculate statistics comparing the baseline and comparison datasets.

Parameters:

data (ExperimentData) – The ExperimentData to execute the comparator on

Returns:

The ExperimentData with the comparison results

Return type:

ExperimentData