meridian.data.input_data.InputData

Conteneur de données publicitaires dans un format accepté par Meridian.

meridian.data.input_data.InputData(
    kpi: xr.DataArray,
    kpi_type: str,
    controls: xr.DataArray,
    population: xr.DataArray,
    revenue_per_kpi: (xr.DataArray | None) = None,
    media: (xr.DataArray | None) = None,
    media_spend: (xr.DataArray | None) = None,
    reach: (xr.DataArray | None) = None,
    frequency: (xr.DataArray | None) = None,
    rf_spend: (xr.DataArray | None) = None,
    organic_media: (xr.DataArray | None) = None,
    organic_reach: (xr.DataArray | None) = None,
    organic_frequency: (xr.DataArray | None) = None,
    non_media_treatments: (xr.DataArray | None) = None
)

kpi Un DataArray de dimensions (n_geos, n_times) contenant la variable dépendante non négative. Il s'agit généralement du nombre d'unités vendues, mais il peut s'agir de n'importe quelle métrique, comme les revenus ou les conversions.
kpi_type Chaîne indiquant si le KPI est du type 'revenue' ou 'non-revenue'. Lorsque kpi_type est défini sur 'non-revenue' et que revenue_per_kpi existe, la calibration du ROI est utilisée et l'analyse est exécutée sur les revenus. Lorsque revenue_per_kpi n'existe pas pour le même kpi_type, la calibration personnalisée du ROI est utilisée et l'analyse est exécutée sur le KPI.
controls Un DataArray de dimensions (n_geos, n_times, n_controls) contenant des valeurs de variables de contrôle.
population Un DataArray de dimensions (n_geos,) contenant la population de chaque groupe. Cette variable permet de mettre à l'échelle le KPI et le média pour la modélisation.
revenue_per_kpi Un DataArray facultatif de dimensions (n_geos, n_times) contenant le montant des revenus moyens par unité de KPI. Bien que la modélisation soit effectuée sur kpi, l'analyse et l'optimisation du modèle sont effectuées sur KPI * revenue_per_kpi (revenus), si cette valeur est disponible. Si kpi correspond aux revenus, un tableau de valeurs "1" est alors transmis automatiquement.
media Un DataArray facultatif de dimensions (n_geos, n_media_times, n_media_channels) contenant des valeurs d'exécution média non négatives. Il s'agit généralement d'impressions, mais il peut s'agir de n'importe quelle métrique, comme le coût ou les clics. n_media_times doit être supérieur ou égal à n_times, et les périodes n_times finales doivent correspondre à la période de kpi et controls. En raison des effets différés, nous vous recommandons de définir une période pour le média qui inclut jusqu'à max_lag périodes supplémentaires avant cette période. Si n_media_times < n_times + max_lag, le modèle impute en réalité l'historique média comme zéro (aucune exécution média). Si n_media_times > n_times + max_lag, seules les n_times + max_lag périodes finales sont utilisées pour ajuster le modèle. media et media_spend doivent contenir le même nombre de canaux média dans le même ordre. Si l'un de ces arguments est transmis, l'autre n'est pas facultatif.
media_spend Un DataArray facultatif contenant le coût de chaque canal média. Ce montant est utilisé comme dénominateur pour les calculs du ROI. La forme du DataArray peut être (n_geos, n_times, n_media_channels) ou (n_media_channels,) si les données sont agrégées sur les dimensions geo et time. Nous vous recommandons d'aligner le total des dépenses sur la période des données kpi et controls, qui correspond à la période sur laquelle le résultat incrémental du numérateur du ROI est calculé. Toutefois, notez que le résultat incrémental est influencé par l'exécution média avant cette période, par le biais des effets différés, et qu'il exclut les effets différés au-delà de la période du média exécuté pendant la période. media et media_spend doivent contenir le même nombre de canaux média dans le même ordre. Si l'un de ces arguments est transmis, l'autre n'est pas facultatif.
reach Un DataArray facultatif de dimensions (n_geos, n_media_times, n_rf_channels) contenant des valeurs reach non négatives. n_media_times doit être supérieur ou égal à n_times, et les périodes n_times finales doivent correspondre à la période de kpi et controls. La période doit inclure la période des données kpi et controls, mais il est facultatif d'inclure des périodes différées avant la période des données kpi et controls. Si la couverture différée n'est pas incluse ou si elle inclut moins de max_lag périodes, le modèle calcule Adstock en supposant que l'exécution de la couverture est nulle avant la première période observée. Nous vous recommandons d'inclure n_times + max_lag périodes, sauf si la valeur de max_lag est trop élevée. Si seules les données media sont utilisées, reach sera None. reach, frequency et rf_spend doivent contenir le même nombre de canaux média dans le même ordre. Si l'un de ces arguments est transmis, les autres ne sont pas facultatifs.
frequency Un DataArray facultatif de dimensions (n_geos, n_media_times, n_rf_channels) contenant des valeurs frequency non négatives. n_media_times doit être supérieur ou égal à n_times, et les périodes n_times finales doivent correspondre à la période de kpi et controls. La période doit inclure la période des données kpi et controls, mais il est facultatif d'inclure des périodes différées avant la période des données kpi et controls. Si la fréquence différée n'est pas incluse ou si elle comprend moins de max_lag périodes, le modèle calcule Adstock en supposant que l'exécution de la fréquence est nulle avant la première période observée. Nous vous recommandons d'inclure n_times + max_lag périodes, sauf si la valeur de max_lag est trop élevée. Si seules les données media sont utilisées, frequency sera None. reach, frequency et rf_spend doivent contenir le même nombre de canaux média dans le même ordre. Si l'un de ces arguments est transmis, les autres ne sont pas facultatifs.
rf_spend Un DataArray facultatif contenant le coût de chaque canal de couverture et de fréquence. Ce montant est utilisé comme dénominateur pour les calculs du ROI. La forme du DataArray peut être (n_rf_channels,), (n_geos, n_times, n_rf_channels) ou (n_geos, n_rf_channels). Les dépenses doivent être agrégées sur les dimensions géographiques et/ou temporelles qui ne sont pas représentées. Nous vous recommandons d'aligner le total des dépenses sur la période des données kpi et controls, qui correspond à la période sur laquelle le résultat incrémental du numérateur du ROI est calculé. Toutefois, notez que le résultat incrémental est influencé par l'exécution média avant cette période, par le biais des effets différés, et qu'il exclut les effets différés au-delà de la période du média exécuté pendant la période. Si seules les données media sont utilisées, rf_spend sera None. reach, frequency et rf_spend doivent contenir le même nombre de canaux média dans le même ordre. Si l'un de ces arguments est transmis, les autres ne sont pas facultatifs.
organic_media Un DataArray facultatif de dimensions (n_geos, n_media_times, n_organic_media_channels) contenant des valeurs média naturel non négatives. Les variables média naturel sont des activités média sans coût direct. Elles peuvent inclure les impressions provenant de newsletters, d'un article de blog, d'une activité sur les réseaux sociaux ou de campagnes par e-mail, mais il peut s'agir de n'importe quelle métrique, comme les clics. n_media_times doit être supérieur ou égal à n_times, et les n_times périodes finales doivent correspondre à la période de kpi et controls. En raison des effets différés, nous vous recommandons de définir une période pour le média naturel qui inclut jusqu'à max_lag périodes supplémentaires avant cette période. Si n_organic_media_times < n_times + max_lag, le modèle impute en réalité l'historique média naturel. Si n_organic_media_times > n_times + max_lag, seules les n_times + max_lag périodes finales sont utilisées pour ajuster le modèle.
organic_reach Un DataArray facultatif de dimensions (n_geos, n_media_times, n_organic_rf_channels) contenant des valeurs de couverture naturelle non négatives. n_media_times doit être supérieur ou égal à n_times, et les n_times périodes finales doivent correspondre à la période de kpi et controls. La période doit inclure la période des données kpi et controls, mais il est facultatif d'inclure des périodes différées avant la période des données kpi et controls. Si la couverture différée n'est pas incluse ou si elle inclut moins de max_lag périodes, le modèle calcule Adstock en supposant que l'exécution de la couverture est nulle avant la première période observée. Nous vous recommandons d'inclure n_times + max_lag périodes, sauf si la valeur de max_lag est trop élevée. Si aucune donnée de couverture et de fréquence naturelles n'est utilisée, organic_reach et organic_frequency seront None. organic_reach et organic_frequency doivent contenir le même nombre de canaux dans le même ordre. Si l'un de ces arguments est transmis, l'autre n'est pas facultatif.
organic_frequency Un DataArray facultatif de dimensions (n_geos, n_media_times, n_organic_rf_channels) contenant des valeurs de fréquence naturelle non négatives. n_media_times doit être supérieur ou égal à n_times, et les n_times périodes finales doivent correspondre à la période de kpi et controls. La période doit inclure la période des données kpi et controls, mais il est facultatif d'inclure des périodes différées avant la période des données kpi et controls. Si la fréquence différée n'est pas incluse ou si elle comprend moins de max_lag périodes, le modèle calcule Adstock en supposant que l'exécution de la fréquence est nulle avant la première période observée. Nous vous recommandons d'inclure n_times + max_lag périodes, sauf si la valeur de max_lag est trop élevée. Si aucune donnée de couverture et de fréquence naturelles n'est utilisée, organic_frequency sera None. organic_reach et organic_frequency doivent contenir le même nombre de canaux dans le même ordre. Si l'un de ces arguments est transmis, l'autre n'est pas facultatif.
non_media_treatments Un DataArray facultatif de dimensions (n_geos, n_times, n_non_media_channels) contenant des valeurs de variables de traitement non média. Les variables de traitement non média sont des activités marketing menées par l'annonceur qui ne sont pas directement liées aux médias. Elles ne sont associées à aucun coût marketing direct, mais contrairement aux variables média naturel, elles ne présentent pas d'effets Adstock et Hill. Elles diffèrent des variables de contrôle, car elles sont considérées comme des variables d'intervention et sont donc des variables de traitement dans le modèle causal. Voici quelques exemples : lancer une promotion, modifier le prix d'un produit, ou encore changer l'emballage et/ou le design d'un produit.
control_variable Renvoie la dimension de la variable de contrôle.
geo Renvoie la dimension géographique.
media_channel Renvoie la dimension du canal média.
media_spend_has_geo_dimension Vérifie si le tableau media_spend comporte une dimension géographique.
media_spend_has_time_dimension Vérifie si le tableau media_spend comporte une dimension temporelle.
media_time Renvoie les coordonnées de la dimension temporelle du média.
media_time_coordinates Renvoie la dimension temporelle du média dans un wrapper TimeCoordinates.
non_media_channel Renvoie la dimension du canal de traitements non média.
organic_media_channel Renvoie la dimension du canal média naturel.
organic_rf_channel Renvoie la dimension du canal avec couverture et fréquence naturelles.
rf_channel Renvoie la dimension du canal avec couverture et fréquence.
rf_spend_has_geo_dimension Vérifie si le tableau rf_spend comporte une dimension géographique.
rf_spend_has_time_dimension Vérifie si le tableau rf_spend comporte une dimension temporelle.
time Renvoie les coordonnées de la dimension temporelle.
time_coordinates Renvoie la dimension temporelle (KPI) dans un wrapper TimeCoordinates.

Méthodes

as_dataset

Afficher la source

as_dataset() -> xr.Dataset

Renvoie les données sous la forme d'un seul objet xarray.Dataset.

get_all_channels

Afficher la source

get_all_channels() -> np.ndarray

Renvoie toutes les dimensions du canal.

Cette méthode renvoie les noms des canaux média, avec couverture et fréquence, média naturel, avec couverture et fréquence naturelles, et non média, concaténés dans un seul tableau dans cet ordre.

get_all_media_and_rf

Afficher la source

get_all_media_and_rf() -> np.ndarray

Renvoie toutes les valeurs d'exécution média, y compris les dimensions "média" et "couverture et fréquence".

Si le média, la couverture et la fréquence ont été utilisés pour la modélisation, la couverture * fréquence est concaténée à la fin du média.

Renvoie
np.ndarray avec les dimensions (n_geos, n_media_times, n_channels) contenant le média ou la couverture * fréquence pour chaque media_channel ou rf_channel.

get_all_paid_channels

Afficher la source

get_all_paid_channels() -> np.ndarray

Renvoie toutes les dimensions du canal payant, y compris les dimensions "média" et "couverture et fréquence".

Si les canaux "média" et "avec couverture et fréquence" sont tous deux présents, les canaux avec couverture et fréquence sont concaténés à la fin des canaux média.

get_n_top_largest_geos

Afficher la source

get_n_top_largest_geos(
    num_geos: int
) -> list[str]

Recherche le nombre spécifié de zones géographiques les plus importantes en termes de population.

Args
num_geos Nombre de zones géographiques les plus importantes à renvoyer en fonction de la population.

Renvoie
Une liste du nombre spécifié de zones géographiques les plus importantes.

get_total_spend

Afficher la source

get_total_spend() -> np.ndarray

Renvoie les dépenses totales, y compris media_spend et rf_spend.

__eq__

__eq__(
    other
)

Return self==value.

frequency None
media None
media_spend None
non_media_treatments None
organic_frequency None
organic_media None
organic_reach None
reach None
revenue_per_kpi None
rf_spend None