meridian.analysis.visualizer.ModelDiagnostics

Meridian モデルのフィッティングからモデル診断プロットを生成します。

meridian.analysis.visualizer.ModelDiagnostics(
    meridian: meridian.model.model.Meridian
)

メソッド

plot_prior_and_posterior_distribution

ソースを表示

plot_prior_and_posterior_distribution(
    parameter: str = 'roi_m',
    num_geos: int = 3,
    selected_times: (list[str] | None) = None
) -> (alt.Chart | alt.FacetChart)

モデル パラメータの事前分布と事後分布をプロットします。

引数
parameter プロットするモデル パラメータ名。名前が指定されていない場合、デフォルトでは、費用対効果パラメータが表示されます。
num_geos 地域レベルのパラメータのプロットに表示する、人口が最も多い地域の数。デフォルトでは、人口の多い上位 3 つの地域のみが表示されます。
selected_times 時間レベル パラメータでプロットする期間のリスト。この期間は、データの期間と一致している必要があります。デフォルトでは、最初の 3 つの期間がプロットされます。

戻り値
パラメータ分布を表す Altair プロット。

発生するエラー
NotFittedModelError モデルがフィッティングされていない場合。
ValueError parameter が Meridian モデル パラメータではない場合。

plot_rhat_boxplot

ソースを表示

plot_rhat_boxplot() -> alt.Chart

R-hat の箱ひげ図をプロットします。

連鎖収束の Gelman および Rubin（1992 年）の潜在的スケール減少（一般に R-hat と呼ばれます）の視覚的な概要。これは、連鎖間の（平均値の）分散が、連鎖が均一に分布した場合に予想される分散をどの程度超過するかを測定する収束診断指標です。値が 1.0 に近いほど、収束が進んでいることを示します。R-hat が 1.2 に満たない場合は近似収束を示しており、多くの問題で妥当なしきい値になります（Brooks および Gelman、1998 年）。

モデルのパラメータごとに R-hat 値が 1 つずつあります。箱ひげ図は、インデックス全体の R-hat 値の分布を要約したものです。たとえば、beta_gm に対応する箱は、地域インデックス g とチャネル インデックス m の両方における R-hat 値の分布を要約しています。

決定論的事前分布を持つパラメータには R-hat が定義されないため、これらのパラメータは箱ひげ図に表示されません。

参照
Andrew Gelman および Donald B. Rubin。Inference from Iterative Simulation Using Multiple Sequences。Statistical Science、7(4):457-472、1992 年。 Stephen P. Brooks および Andrew Gelman。General Methods for Monitoring Convergence of Iterative Simulations

戻り値
パラメータごとの R-hat 箱ひげ図を示す Altair プロット。

発生するエラー
NotFittedModelError モデルがフィッティングされていない場合。
MCMCSamplingError MCMC サンプリングが収束しなかった場合。

predictive_accuracy_table

ソースを表示

predictive_accuracy_table(
    selected_geos: (Sequence[str] | None) = None,
    selected_times: (Sequence[str] | None) = None,
    column_var: (str | None) = None,
    batch_size: int = c.DEFAULT_BATCH_SIZE
) -> pd.DataFrame

DataFrame の予測精度を表示します。

引数
selected_geos プロットに含める一部の地域ディメンションのリスト（省略可）。デフォルトでは、すべての地域が含まれます。地域は、meridian.InputData の地域ディメンション名と一致している必要があります。selected_geos または n_top_largest_geos のいずれかを設定します。両方は設定しないでください。
selected_times プロットに含める一部の時間ディメンションのリスト（省略可）。デフォルトでは、すべての時間が含まれます。時間は、meridian.InputData の時間ディメンションと一致している必要があります。
column_var metric、geo_granularity、evaluation_set のいずれを軸にテーブルをピボットするかを示す文字列（省略可）。デフォルトでは column_var=None となり、ピボットされずに返される DataFrame に、metric、geo_granularity、value の列が（holdout_id が None でない場合は evaluation_set の列も）表示されます。
batch_size 各バッチでのチェーンあたりの最大抽出数を表す整数。メモリの枯渇を回避するため、計算はバッチで実行されます。メモリエラーが発生した場合は、batch_size を減らしてみてください。計算は通常、batch_size の値が大きいほど高速になります。

戻り値
計算された R_Squared、MAPE、wMAPE の値を含む DataFrame。holdout_id が存在する場合は、データが Train、Test、All Data のサブセクションに分割され、evaluation_set がデータセットから DataFrame に変換されて、列として含まれます。