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,
    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 など）の分布は、スカラー分布またはベクトル分布として渡すことができます。スカラー分布が渡された場合、パラメータ ベクトルの実際の形状にブロードキャストされます。関連する詳細情報については、paid_media_prior_type をご覧ください。
media_effects_dist 複数の地域にまたがるメディアのランダム効果の分布を指定する文字列。この属性は、国レベルのモデルでは使用されません。利用できる値: 'normal' または 'log_normal'。デフォルト: 'log_normal'。
hill_before_adstock デフォルトの順序（Adstock 関数、Hill 関数の順）ではなく、Hill 関数、Adstock 関数の順に適用するかどうかを示すブール値。この引数は RF チャネルには適用されません。デフォルト: False。
max_lag Adstock の計算に含める遅延期間の最大数（0 以上）を示す整数。無限大の最大遅延と同等の None に設定することもできます。デフォルト: 8。
unique_sigma_for_each_geo 地域ごとに一意の残差分散を使用するかどうかを示すブール値。False の場合、すべての地域で単一の残差分散が使用されます。デフォルト: False。
paid_media_prior_type メディア係数の事前分布の種類を指定する文字列。使用できる値: 'roi'、'mroi'、'coefficient'。デフォルト: 'roi'。PriorDistribution には roi_m、mroi_m、beta_m の分布が含まれていますが、paid_media_prior_type に応じてこれらのうちの 1 つだけが使用されます。同様に、PriorDistribution には roi_rf、mroi_rf、beta_rf の分布が含まれていますが、paid_media_prior_type に応じてこれらのうちの 1 つだけが使用されます。paid_media_prior_type が 'roi' の場合は、ROI の事前分布を指定するために、PriorDistribution.roi_m パラメータと PriorDistribution.roi_rf パラメータが使用されます。paid_media_prior_type が 'mroi' の場合は、mROI の事前分布を指定するために、PriorDistribution.mroi_m パラメータと PriorDistribution.mroi_rf パラメータが使用されます。paid_media_prior_type が 'coefficient' の場合は、係数の平均パラメータの事前分布を指定するために、PriorDistribution.beta_m パラメータと PriorDistribution.beta_rf パラメータが使用されます。
roi_calibration_period roi_m 事前分布の ROI 値（または mroi_m 事前分布の mROI 値）が適用される time のサブセットを示す、形状 (n_media_times, n_media_channels) のブール値配列（省略可）。None の場合、すべての期間が使用されます。デフォルト: None。
rf_roi_calibration_period roi_rf 事前分布の ROI 値（または mroi_rf 事前分布の mROI 値）が適用される time のサブセットを示す、形状 (n_media_times, n_rf_channels) のブール値配列（省略可）。None の場合、すべての期間が使用されます。デフォルト: None。
knots 時間効果の推定に使用されるノットを示す整数または整数のリスト（省略可）。knots が整数のリストの場合、ノットの位置はそのリストによって指定されます。0 は最初の期間のノット、1 は 2 番目の期間のノット、(n_times - 1) は最後の期間のノットにそれぞれ対応します。通常、0 と (n_times - 1) のノットを含めることをおすすめしますが、必須ではありません。knots が整数の場合、ノットは期間全体に等間隔で配置されます（0 と (n_times - 1) のノットを含む）。knots が 1 の場合、すべての期間で共通の回帰係数が 1 つ使用されます。knots が None に設定されている場合、使用されるノット数は、地域モデルにおける期間の数と同じです。これは、各期間に独自の回帰係数がある場合と同じです。国モデルで knots が None に設定されている場合、使用されるノットの数は 1 です。デフォルト: None。
baseline_geo ベースラインの地域の整数または文字列（省略可）。ベースラインの地域は、地域のダミー エンコードで参照地域として処理されます。ベースライン以外の地域には、対応するインジケーター変数 tau_g があるため、ベースラインの地域よりも事前分布の分散が大きくなります。None に設定すると、人口が最も多い地域がベースラインとして使用されます。デフォルト: None。
holdout_id ディメンション (n_geos, n_times)（地域レベルのモデルの場合）またはディメンション (n_times,)（全国モデルの場合）のブール値テンソル（いずれも省略可）。どの観測データがホールドアウト サンプル（トレーニング サンプルから除外されるデータ）に該当するかを示します。トレーニング サンプルから除外されるのは、KPI データのみです。メディアデータは、その後の週の Adstock に影響する可能性があるため、引き続き含まれます。「ROI 事前分布」を使用する場合、roi_m パラメータは、ホールドアウト サンプル内のものを含め、すべての地域と期間の ROI に対応します。
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
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