meridian.model.spec.ModelSpec

Parametri di specifica del modello per Meridian.

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,
    use_roi_prior: bool = True,
    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
)

Questa classe contiene tutti i parametri del modello che non cambiano tra le esecuzioni di Meridian.

prior Un oggetto PriorDistribution che specifica la distribuzione a priori di ogni insieme di parametri del modello. La distribuzione per un vettore di parametri (ad esempio alpha_m) può essere passata come distribuzione scalare o come distribuzione vettoriale. Se viene passata una distribuzione scalare, viene trasmessa alla forma effettiva del vettore di parametri. Tieni presente che PriorDistribution contiene distribuzioni sia per roi_m che per beta_m, ma viene utilizzato solo uno di questi. Se use_roi_prior è impostato su True, viene utilizzato il prior roi_m. In caso contrario, viene utilizzato il valore beta_m precedente.
media_effects_dist Una stringa per specificare la distribuzione degli effetti casuali dei contenuti multimediali nelle aree geografiche. Questo attributo non viene utilizzato con un modello a livello nazionale. Valori consentiti: 'normal' o 'log_normal'. Valore predefinito: 'log_normal'.
hill_before_adstock Un valore booleano che indica se applicare la funzione Hill prima della funzione Adstock, anziché l'ordine predefinito di Adstock prima di Hill. Questo argomento non si applica ai canali RF. Valore predefinito: False.
max_lag Un numero intero che indica il numero massimo di periodi di tempo di sfasamento (≥ 0) da includere nel calcolo dell'inventario pubblicitario inutilizzato. Può essere impostato anche su None, che equivale a un ritardo massimo infinito. Valore predefinito: 8.
unique_sigma_for_each_geo Un valore booleano che indica se utilizzare o meno una varianza residua distinta per ogni località. Se False, viene utilizzata una singola varianza residuale per tutti i paesi. Valore predefinito: False.
use_roi_prior (ritirato, utilizza paid_media_prior_type) Un valore booleano che indica se utilizzare i prior ROI e il prior su roi_m nel prior. Se False, viene utilizzato il valore precedente per beta_m nel precedente. Valore predefinito: True.
paid_media_prior_type Una stringa per specificare il tipo precedente per i coefficienti media. Valori consentiti: 'roi', 'mroi', 'coefficient'. Valore predefinito: 'roi'. Se paid_media_prior_type è "coefficiente", then thePriorContainer.beta_mandPriorContainer.beta_rfattributes are used to specify a prior on the coefficient mean parameters (and thePriorContainer.roi_mandPriorContainer.roi_rfattributes will be ignored). Ifpaid_media_prior_type' è 'roi' o 'mroi', gli attributi PriorContainer.roi_m e PriorContainer.roi_rf vengono utilizzati per specificare un valore precedente rispettivamente per il ROI o il ROI medio (e gli attributi PriorContainer.beta_m e PriorContainer.beta_rf verranno ignorati).
roi_calibration_period Un array booleano facoltativo di forma (n_media_times, n_media_channels) che indica il sottoinsieme di time a cui si applica il valore ROI (o mROI) del precedente roi_m. Se None, vengono utilizzati tutti i tempi. Valore predefinito: None.
rf_roi_calibration_period Un array booleano facoltativo di forma (n_media_times, n_rf_channels) che indica il sottoinsieme di time a cui si applica il valore ROI (o mROI) del roi_rf precedente. Se None, vengono utilizzati tutti i valori di orario. Valore predefinito: None.
knots Un numero intero facoltativo o un elenco di numeri interi che indicano i nodi utilizzati per stimare gli effetti del tempo. Quando knots è un elenco di numeri interi, le posizioni dei nodi sono fornite da quell'elenco. Zero corrisponde a un nodo nel primo periodo di tempo, 1 corrisponde a un nodo nel secondo periodo di tempo, … e (n_times - 1) corrisponde a un nodo nell'ultimo periodo di tempo). In genere, consigliamo di includere i nodi in 0 e (n_times - 1), ma non è obbligatorio. Quando knots è un numero intero, ci sono nodi con posizioni equidistanti nei periodi di tempo, inclusi i nodi a zero e (n_times - 1). Quando knots è1, viene utilizzato un unico coefficiente di regressione comune per tutti i periodi di tempo. Se knots è impostato su None, il numero di nodi utilizzati è uguale al numero di periodi di tempo nel caso di un modello geografico. Ciò equivale a dire che ogni periodo di tempo ha il proprio coefficiente di regressione. Se knots è impostato su None nel caso di un modello nazionale, il numero di nodi utilizzati è 1. Valore predefinito: None.
baseline_geo Un numero intero facoltativo o una stringa per i dati geografici di riferimento. La dimensione geografica di riferimento viene trattata come la dimensione geografica di riferimento nella codifica fittizia delle dimensioni geografiche. I dati geografici non di riferimento hanno una variabile di indicatore tau_g corrispondente, ovvero hanno una varianza a priori più elevata rispetto ai dati geografici di riferimento. Se impostato su None, come valore di riferimento viene utilizzata la località con la popolazione più numerosa. Valore predefinito: None.
holdout_id Tensore booleano facoltativo di dimensioni (n_geos, n_times) per un modello a livello geografico o (n_times,) per un modello nazionale, che indica quali osservazioni fanno parte del campione di controllo, che vengono escluse dal campione di addestramento. Solo i dati KPI vengono esclusi dal campione di addestramento. I dati media sono comunque inclusi perché possono influire sull'inventario pubblicitario per le settimane successive. Se vengono utilizzati "priori ROI", come use_roi_prior=True, i parametri roi_m corrispondono al ROI di tutti i dati geografici e temporali, anche quelli nel campione di controllo.
control_population_scaling_id Un tensore booleano facoltativo di dimensione (n_controls,) che indica le variabili di controllo per le quali il valore del controllo verrà scalato in base alla popolazione. Se None, nessuna variabile di controllo viene calibrata in base alla popolazione. Valore predefinito: None.
non_media_population_scaling_id Un tensore booleano facoltativo di dimensione (n_non_media_channels,) che indica le variabili non media per le quali il valore non media verrà scalato in base alla popolazione. Se None, nessuna variabile diversa dai contenuti media viene scalata in base alla popolazione. Valore predefinito: None.

Metodi

__eq__

__eq__(
    other
)

Restituisce self==value.

baseline_geo None
control_population_scaling_id None
hill_before_adstock False
holdout_id None
nodi 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
use_roi_prior True