meridian.model.spec.ModelSpec

Parameter für die Meridian-Modellspezifikation.

meridian.model.spec.ModelSpec(
    prior: meridian.model.prior_distribution.PriorDistribution = dataclasses.field(default_factory=prior_distribution.PriorDistribution),
    media_effects_dist: str = constants.MEDIA_EFFECTS_LOG_NORMAL,
    hill_before_adstock: bool = False,
    max_lag: (int | None) = 8,
    unique_sigma_for_each_geo: bool = False,
    paid_media_prior_type: str = constants.PAID_MEDIA_PRIOR_TYPE_ROI,
    roi_calibration_period: (np.ndarray | None) = None,
    rf_roi_calibration_period: (np.ndarray | None) = None,
    knots: (int | list[int] | None) = None,
    baseline_geo: (int | str | None) = None,
    holdout_id: (np.ndarray | None) = None,
    control_population_scaling_id: (np.ndarray | None) = None,
    non_media_population_scaling_id: (np.ndarray | None) = None
)

Diese Klasse enthält alle Modellparameter, die sich zwischen den Ausführungen von Meridian nicht ändern.

prior Ein PriorDistribution-Objekt, das die Prior-Verteilung für jede Gruppe von Modellparametern angibt. Die Verteilung für einen Parametervektor (z. B. alpha_m) kann entweder als skalare Verteilung oder als Vektorverteilung übergeben werden. Wenn eine skalare Verteilung übergeben wird, wird sie an die tatsächliche Form des Parametervektors gesendet. Weitere Informationen finden Sie unter paid_media_prior_type.
media_effects_dist Ein String, mit dem die Verteilung der zufälligen Media-Effekte über verschiedene geografische Einheiten hinweg angegeben wird. Dieses Attribut wird nicht mit einem Modell auf Länderebene verwendet. Zulässige Werte: 'normal' oder 'log_normal'. Standard: 'log_normal'.
hill_before_adstock Ein boolescher Wert, der angibt, ob die Hill-Funktion vor der Adstock-Funktion angewendet werden soll, im Gegensatz zur Standardreihenfolge von Adstock vor Hill. Dieses Argument wird nicht auf Channels mit Daten zu Reichweite und Häufigkeit angewendet. Standard: False.
max_lag Eine Ganzzahl, die die maximale Anzahl von Verzögerungsperioden (≥ 0) angibt, die in die Adstock-Berechnung einbezogen werden sollen. Sie kann auch auf None gesetzt werden, was einer unendlichen maximalen Verzögerung entspricht. Standard: 8.
unique_sigma_for_each_geo Ein boolescher Wert, der angibt, ob für jede geografische Einheit eine eigene Residualvarianz verwendet werden soll. Wenn False festgelegt ist, wird für alle geografischen Einheiten eine gemeinsame Residualvarianz verwendet. Standard: False.
paid_media_prior_type Ein String, mit dem der Prior-Typ für die Media-Koeffizienten angegeben wird. Zulässige Werte: 'roi', 'mroi', 'coefficient'. Standard: 'roi'. PriorDistribution enthält die Verteilungen roi_m, mroi_m und beta_m. Je nach paid_media_prior_type wird aber nur eine davon verwendet. Ebenso enthält PriorDistribution die Verteilungen roi_rf, mroi_rf und beta_rf, aber je nach paid_media_prior_type wird nur eine davon verwendet. Wenn paid_media_prior_type = 'roi' ist, werden die Parameter PriorDistribution.roi_m und PriorDistribution.roi_rf verwendet, um einen Prior für den ROI anzugeben. Wenn paid_media_prior_type = 'mroi' ist, werden die Parameter PriorDistribution.mroi_m und PriorDistribution.mroi_rf verwendet, um einen Prior für den Grenz-ROI anzugeben. Wenn paid_media_prior_type = 'coefficient' ist, werden die Parameter PriorDistribution.beta_m und PriorDistribution.beta_rf verwendet, um einen Prior für die durchschnittlichen Parameter der Koeffizienten anzugeben.
roi_calibration_period Ein optionales boolesches Array der Form (n_media_times, n_media_channels), das die Teilmenge von time angibt, auf die sich der ROI-Wert des roi_m-Priors (oder der Grenz-ROI-Wert des mroi_m-Priors) bezieht. Bei None werden alle Zeiträume verwendet. Standard: None.
rf_roi_calibration_period Ein optionales boolesches Array der Form (n_media_times, n_rf_channels), das die Teilmenge von time angibt, auf die sich der ROI-Wert des roi_rf-Priors (oder der Grenz-ROI-Wert des mroi_rf-Priors) bezieht. Bei None werden alle Zeiträume verwendet. Standard: None.
knots Eine optionale Ganzzahl oder Liste mit Ganzzahlen, die die Knoten angibt, die zur Schätzung der Zeiteffekte verwendet werden. Wenn knots eine Liste von Ganzzahlen ist, werden die Knotenpositionen davon bereitgestellt. „0“ entspricht einem Knoten im ersten Zeitraum, „1“ einem Knoten im zweiten Zeitraum usw. (n_times - 1) entspricht einem Knoten im letzten Zeitraum. Normalerweise empfehlen wir, Knoten an den Punkten 0 und (n_times - 1) einzufügen. Dies ist jedoch nicht erforderlich. Wenn knots eine Ganzzahl ist, sind die Knotenpositionen gleichmäßig über die Zeiträume verteilt, einschließlich der Knoten bei „0“ und (n_times - 1). Wenn knots gleich 1 ist, wird für alle Zeiträume ein gemeinsamer Regressionskoeffizient verwendet. Wenn knots auf None festgelegt ist, entspricht die Anzahl der verwendeten Knoten bei einem geografischen Modell der Anzahl der Zeiträume. Das bedeutet, dass jeder Zeitraum einen eigenen Regressionskoeffizienten hat. Wenn knots bei einem länderspezifischen Modell auf None gesetzt ist, beträgt die Anzahl der Knoten 1. Standard: None.
baseline_geo Optionale Ganzzahl oder String für die geografische Baseline. Die geografische Baseline wird bei der Dummy-Codierung von geografischen Einheiten als Referenz behandelt. Andere geografische Einheiten (nicht Baseline) haben eine entsprechende tau_g-Indikatorvariable. Sie haben also eine höhere Prior-Varianz als die geografische Baseline. Ist None festgelegt, wird die geografische Einheit mit der größten Bevölkerung als Baseline verwendet. Standard: None.
holdout_id Optionaler boolescher Tensor mit den Dimensionen (n_geos, n_times) für ein Modell auf geografischer Ebene oder (n_times,) für ein länderspezifisches Modell, der angibt, welche Beobachtungen zur Holdout-Stichprobe gehören und welche von der Trainingsstichprobe ausgeschlossen sind. Nur KPI-Daten werden aus der Trainingsstichprobe ausgeschlossen. Media-Daten werden weiterhin berücksichtigt, weil sie sich auf den Adstock-Effekt der folgenden Wochen auswirken können. Wenn ROI-Priors verwendet werden, entsprechen die -roi_m-Parameter dem ROI aller geografischen Einheiten und Zeiträume, auch denen in der Holdout-Stichprobe.
control_population_scaling_id Optionaler boolescher Tensor der Dimension (n_controls,), der die Kontrollvariablen angibt, für die der Kontrollwert nach Bevölkerung skaliert wird. Falls None, werden keine Kontrollvariablen nach Bevölkerung skaliert. Standard: None.
non_media_population_scaling_id Optionaler boolescher Tensor der Dimension (n_non_media_channels,), der die nicht mediabezogenen Variablen angibt, für die der nicht mediabezogene Wert nach Bevölkerung skaliert wird. Bei None werden keine nicht mediabezogenen Variablen nach Bevölkerung skaliert. Standard: None.

Methoden

__eq__

__eq__(
    other
)

Gibt zurück, ob „self==value“.

baseline_geo None
control_population_scaling_id None
hill_before_adstock False
holdout_id None
knots None
max_lag 8
media_effects_dist 'log_normal'
non_media_population_scaling_id None
paid_media_prior_type 'roi'
rf_roi_calibration_period None
roi_calibration_period None
unique_sigma_for_each_geo False