base

Base class for adstock and saturation functions used in MMM.

Use the subclasses directly for custom transformations:

• Adstock Transformations: pymc_marketing.mmm.components.adstock.AdstockTransformation

• Saturation Transformations: pymc_marketing.mmm.components.saturation.SaturationTransformation

Functions

create_registration_meta(subclasses)	Create a metaclass for registering subclasses.
index_variable(var, dims, idx)	Index a variable based on the provided dimensions and index.

Classes

Transformation([priors, prefix])

Base class for adstock and saturation functions.

Exceptions

DuplicatedTransformationError(name, lookup_name)	Exception when a transformation is duplicated.
MissingDataParameter()	Error if the function doesn't have a data parameter.
ParameterPriorException(priors, parameters)	Error when the functions and specified priors don't match up.