meridian.model.spec.ModelSpec

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
)

這個類別包含在 Meridian 執行期間不會變更的所有模型參數。

屬性
prior	PriorDistribution 物件：指定每組模型參數的先驗分布。參數向量的分佈 (例如 alpha_m) 可做為純量分佈或向量分佈傳遞。如果傳遞的是一個標量分布，系統會將其廣播至參數向量的實際形狀。請注意，PriorDistribution 包含 roi_m 和 beta_m 的兩種發布，但只會使用其中一種。如果 use_roi_prior 設為 True，系統會使用先前的 roi_m。否則會使用先前的 beta_m。
media_effects_dist	用於指定媒體隨機效果在各區域的分布情形。這項屬性不適用於國家/地區層級模型。允許的值：'normal' 或 'log_normal'。預設值：'log_normal'。
hill_before_adstock	布林值，指出是否要先套用 Hill 函式，再套用 Adstock 函式，而非預設的 Adstock 函式先於 Hill 函式。這個引數不適用於 RF 管道。預設值：False。
max_lag	整數，用來指定 Adstock 計算中所包含的延遲期數量上限 (≥ 0)。也可以設為 None，這相當於無限的最大延遲時間。預設值：8。
unique_sigma_for_each_geo	布林值，指出是否要為每個地理區域使用專屬的殘差變異。如果為 False，則會為所有地理區域使用單一殘差變異。預設值：False。
use_roi_prior	(已淘汰，請改用 paid_media_prior_type) 布林值，指出是否要使用 ROI 先驗值，以及先驗值中的 roi_m 先驗值。如果為 False，則會使用先前 beta_m 中的先前值。預設值：True。
paid_media_prior_type	用來指定媒體係數先前類型的字串。允許的值：'roi'、'mroi'、'coefficient'。預設值：'roi'。如果 paid_media_prior_type 是「係數」, 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' 或 'mroi'，則 PriorContainer.roi_m 和 PriorContainer.roi_rf 屬性會分別用於指定 ROI 或 mROI 的先驗值 (PriorContainer.beta_m 和 PriorContainer.beta_rf 屬性會遭到忽略)。
roi_calibration_period	形狀為 (n_media_times, n_media_channels) 的選用布林值陣列，用於指出 roi_m 的 ROI (或 mROI) 值適用於哪個 time 子集。如果是 None，則會使用所有時間。預設值：None。
rf_roi_calibration_period	可選的布林值陣列，形狀為 (n_media_times, n_rf_channels)，表示 roi_rf 的 ROI (或 mROI) 值適用於 time 的哪個子集。如果是 None，則會使用所有時間。預設值：None。
knots	可選的整數或整數清單，用於表示用於估算時間效果的節數。如果 knots 是整數清單，則該清單會提供節點位置。零對應至第一個時間間隔的節點、一對應至第二個時間間隔的節點，以此類推，(n_times - 1) 則對應至最後一個時間間隔的節點)。一般來說，我們建議在 0 和 (n_times - 1) 中加入節點，但這並非必要。當 knots 為整數時，就會有節點，這些節點的位置在時間間隔中均勻分布 (包括零和 (n_times - 1) 的節點)。當 knots 為 1 時，所有時間範圍都會使用單一常規迴歸係數。如果 knots 設為 None，則使用的節點數量會等於地理模型的時間週期數量。這相當於每個時間範圍都有自己的迴歸係數。如果在國家/地區模型中將 knots 設為 None，則使用的節點數為 1。預設值：None。
baseline_geo	可選的整數或字串，用於基準地理區域。系統會將基準地理區域視為地理區域的虛擬編碼參考地理區域。非基準地理區域會有對應的 tau_g 指標變數，表示其先驗變異數高於基準地理區域。設定為 None 時，系統會使用人口最多的地理區域做為基準。預設值：None。
holdout_id	地理區域層級模型的選用布林值張量維度 (n_geos, n_times)，或國家/地區模型的 (n_times,)，用於指出哪些觀測值屬於保留樣本，而非訓練樣本。訓練樣本只會排除 KPI 資料。媒體資料仍會納入，因為這可能會影響後續幾週的廣告庫存。如果使用「投資報酬率先驗值」，例如 use_roi_prior=True，則 roi_m 參數會對應所有地理區域和時間的投資報酬率，包括保留樣本中的投資報酬率。
control_population_scaling_id	可選的布林值張量，其維度為 (n_controls,)，用於指出控制值會根據人數進行縮放的控制變數。如果為 None，則不會根據母體比例調整任何控制組變數。預設值：None。
non_media_population_scaling_id	可選的布林值張量，其維度為 (n_non_media_channels,)，用於指出非媒體變數，以便根據人口比例縮放非媒體值。如果為 None，則系統不會根據人口比例調整非媒體變數。預設值：None。

方法

__eq__

__eq__(
    other
)

傳回 self==value。

類別變數
baseline_geo	None
control_population_scaling_id	None
hill_before_adstock	False
holdout_id	None
節點	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