meridian.model.adstock_hill.AdstockDecaySpec

Specification for each channel's adstock decay function.

meridian.model.adstock_hill.AdstockDecaySpec(
    media: (str | Sequence[str]) = constants.GEOMETRIC_DECAY,
    rf: (str | Sequence[str]) = constants.GEOMETRIC_DECAY,
    organic_media: (str | Sequence[str]) = constants.GEOMETRIC_DECAY,
    organic_rf: (str | Sequence[str]) = constants.GEOMETRIC_DECAY
)

This class contains the adstock decay function(s) to use for each channel that the adstock transformation is applied to.

Attributes
media	A string or sequence of strings specifying the adstock function(s) to use for media channels.
rf	A string or sequence of strings specifying the adstock function(s) to use for reach and frequency channels.
organic_media	A string or sequence of strings specifying the adstock function(s) to use for organic media channels.
organic_rf	A string or sequence of strings specifying the adstock function(s) to use for organic reach and frequency channels.

Methods

from_consistent_type

View source

@classmethod
from_consistent_type(
    consistent_decay_function: str = constants.GEOMETRIC_DECAY
) -> 'AdstockDecaySpec'

Create an AdstockDecaySpec with the same decay function for all channels.

Arguments
consistent_decay_function	A string denoting the adstock decay function to use for all channels that the Adstock transformation is applied to.

Raises
ValueError	If consistent_decay_function is not 'geometric' or 'binomial'.

__eq__

__eq__(
    other
)

Return self==value.

Class Variables
media	'geometric'
organic_media	'geometric'
organic_rf	'geometric'
rf	'geometric'