RootSaturation

class pymc_marketing.mmm.components.saturation.RootSaturation(priors=None, prefix=None)

Wrapper around Root saturation function.

For more information, see pymc_marketing.mmm.transformers.root_saturation().

(Source code, png, hires.png, pdf)

Methods

RootSaturation.__init__([priors, prefix])
RootSaturation.apply(x[, dims, idx])	Call within a model context.
RootSaturation.function(x, alpha, beta)	Root saturation function.
RootSaturation.plot_curve(curve[, ...])	Plot curve HDI and samples.
RootSaturation.plot_curve_hdi(curve[, ...])	Plot the HDI of the curve.
RootSaturation.plot_curve_samples(curve[, ...])	Plot samples from the curve.
RootSaturation.sample_curve([parameters, ...])	Sample the curve of the saturation transformation given parameters.
RootSaturation.sample_prior([coords])	Sample the priors for the transformation.
RootSaturation.set_dims_for_all_priors(dims)	Set the dims for all priors.
RootSaturation.to_dict()	Convert the transformation to a dictionary.
RootSaturation.update_priors(priors)	Update the priors for a function after initialization.
RootSaturation.with_default_dims(default_dims)	Return a copy of self with default dims set to dims.
RootSaturation.with_new_priors(priors)	Return a copy of the transformation with new priors set.

Attributes

combined_dims	Get the combined dims for all the parameters.
default_priors
function_priors	Get the priors for the function.
lookup_name
model_config	Mapping from variable name to prior for the model.
prefix
priors	Get the priors for the function.
variable_mapping	Mapping from parameter name to variable name in the model.