TanhSaturationBaselinedParameters

class pymc_marketing.mmm.transformers.TanhSaturationBaselinedParameters(x0: Variable | Sequence[Variable] | ArrayLike | XTensorVariable | DataArray, gain: Variable | Sequence[Variable] | ArrayLike | XTensorVariable | DataArray, r: Variable | Sequence[Variable] | ArrayLike | XTensorVariable | DataArray)

Representation of tanh saturation parameters in baselined form.

Parameters:

x0XTensorLike

Baseline spend.

gainXTensorLike

ROAS at \(x_0\).

rXTensorLike

Overspend Fraction.

Methods

TanhSaturationBaselinedParameters.__init__(...)
TanhSaturationBaselinedParameters.count(value, /)	Return number of occurrences of value.
TanhSaturationBaselinedParameters.debaseline()	Change the parameterization to baselined to be classic saturation and cac.
TanhSaturationBaselinedParameters.index(value)	Return first index of value.
TanhSaturationBaselinedParameters.rebaseline(x1)	Change the parameterization to baselined at \(x_1\).

Attributes

gain	Alias for field number 1
r	Alias for field number 2
x0	Alias for field number 0