HillShapeSaturation

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

Hill saturation without an internal scale parameter.

This variant exposes only the shape parameters (slope and kappa) of the Hill function and omits the usual multiplicative beta amplitude found in HillSaturation. It is useful when a single outer channel scaling coefficient (e.g. beta in a media effect or reach-frequency effect) should capture amplitude to avoid non-identifiable products of multiple scale terms.

Methods

HillShapeSaturation.__init__([priors, prefix])
HillShapeSaturation.apply(x, *[, core_dim, idx])	Call within a model context.
HillShapeSaturation.from_dict(data)	Reconstruct a saturation transformation from a dict.
HillShapeSaturation.function(x, slope, kappa, *)	Shape-only Hill saturation.
HillShapeSaturation.plot_curve(curve[, ...])	Plot curve HDI and samples.
HillShapeSaturation.plot_curve_hdi(curve[, ...])	Plot the HDI of the curve.
HillShapeSaturation.plot_curve_samples(curve)	Plot samples from the curve.
HillShapeSaturation.sample_curve([...])	Sample the curve of the saturation transformation given parameters.
HillShapeSaturation.sample_prior([coords])	Sample the priors for the transformation.
HillShapeSaturation.set_dims_for_all_priors(dims)	Set the dims for all priors.
HillShapeSaturation.to_dict([_orig])	Convert the transformation to a dictionary.
HillShapeSaturation.update_priors(priors)	Update the priors for a function after initialization.
HillShapeSaturation.with_default_prior_dims(dims)	Return a copy with default prior dims (dims=None) set to dims instead.
HillShapeSaturation.with_updated_priors(priors)	Return a copy with updated priors.

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.
requires_unscaled_input	Whether the saturation must receive raw (unscaled) channel inputs.
variable_mapping	Mapping from parameter name to variable name in the model.