meridian.analysis.visualizer.ModelDiagnostics

Gera gráficos de diagnóstico do modelo usando a adequação do modelo do Meridian.

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

Métodos

plot_prior_and_posterior_distribution

Ver código-fonte

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

Mostra as distribuições a priori e a posteriori de um parâmetro de modelo.

Args
parameter	Nome do parâmetro do modelo a ser mostrado. Por padrão, o parâmetro do ROI é mostrado quando um nome não é especificado.
num_geos	Número de regiões geográficas maiores por população a serem mostradas nos gráficos de parâmetros de região geográfica. Por padrão, somente as três regiões maiores são mostradas.
selected_times	Lista de períodos específicos a serem mostrados para parâmetros de tempo. Esses períodos precisam corresponder aos períodos dos dados. Por padrão, os três primeiros períodos são mostrados.

Retorna
Um gráfico Altair mostrando as distribuições de parâmetros.

Gera
NotFittedModelError	O modelo não foi ajustado.
ValueError	Um parameter não é um parâmetro de modelo do Meridian.

plot_rhat_boxplot

Ver código-fonte

plot_rhat_boxplot() -> alt.Chart

Mostra o gráfico de caixa R-hat.

Resumo visual da redução de escala potencial de Gelman & Rubin (1992) para a convergência de cadeia, comumente chamada de R-hat. É uma medida de diagnóstico de convergência que mede o grau em que a variância (das médias) entre as cadeias excede o que seria esperado se elas fossem distribuídas de forma idêntica. Valores próximos de 1,0 indicam convergência. R-hat < 1,2 indica a convergência aproximada e é um limite razoável para muitos problemas (Brooks & Gelman, 1998).

Há um único valor de R-hat para cada parâmetro de modelo. O gráfico de caixa resume a distribuição dos valores de R-hat nos índices. Por exemplo, a caixa correspondente a beta_gm resume a distribuição dos valores de R-hat no índice geográfico g e no índice de canal m.

O R-hat não é definido para parâmetros com distribuições a priori deterministas. Portanto, esses parâmetros não são mostrados no gráfico de caixa.

Referências
Andrew Gelman e Donald B. Rubin. Inference from Iterative Simulation Using Multiple Sequences. Statistical Science, 7(4):457-472, 1992. Stephen P. Brooks e Andrew Gelman. General Methods for Monitoring Convergence of Iterative Simulations.

Retorna
Um gráfico Altair mostrando o gráfico de caixa R-hat por parâmetro.

Gera
NotFittedModelError	O modelo não foi ajustado.
MCMCSamplingError	A amostragem de MCMC não convergiu.

predictive_accuracy_table

Ver código-fonte

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

Mostra a precisão preditiva do DataFrame.

Args
selected_geos	Lista opcional de um subconjunto de dimensões geográficas a serem incluídas. Por padrão, todas as regiões geográficas são incluídas e precisam corresponder aos nomes de dimensões em meridian.InputData. Define selected_geos ou n_top_largest_geos, não ambos.
selected_times	Lista opcional de um subconjunto de dimensões de tempo a serem incluídas. Por padrão, todos os períodos são incluídos. Os períodos precisam corresponder às dimensões de tempo de meridian.InputData.
column_var	String opcional que indica se a tabela deve ser dinamizada por metric, geo_granularity ou evaluation_set. Por padrão, column_var=None indica que as colunas metric, geo_granularity e value (junto com evaluation_set quando holdout_id não é None) são exibidas no DataFrame não dinamizado retornado.
batch_size	Número inteiro que representa o número máximo de extrações por cadeia em cada lote. O cálculo é executado em lotes para evitar o esgotamento da memória. Se ocorrer um erro de memória, tente reduzir o batch_size. O cálculo costuma ser mais rápido com valores de batch_size maiores.

Retorna
Um DataFrame que contém os valores computados de R_Squared, MAPE e wMAPE. Se holdout_id existir, os dados serão divididos nas subseções Train, Test e All Data, e evaluation_set será incluído como uma coluna na transformação de conjunto de dados para DataFrame.