meridian.model.transformers.KpiTransformer

Contains forward and inverse KPI transformation methods.

Inherits From: TensorTransformer

meridian.model.transformers.KpiTransformer(
    kpi: meridian.backend.Tensor,
    population: meridian.backend.Tensor
)

This class stores coefficients to scale KPI, first by geo and then by mean and standard deviation of KPI.

Args
kpi	A tensor of dimension (n_geos, n_times) containing the KPI data, used to compute the mean and stddev.
population	A tensor of dimension (n_geos,) containing the population of each geo, used to to compute the population scale factors.

Attributes
population_scaled_kpi
population_scaled_mean
population_scaled_stdev

Methods

forward

View source

forward(
    tensor: meridian.backend.Tensor
) -> meridian.backend.Tensor

Scales a given tensor using the stored coefficients.

inverse

View source

inverse(
    tensor: meridian.backend.Tensor
) -> meridian.backend.Tensor

Scales back a given tensor using the stored coefficients.