meridian.analysis.visualizer.ModelDiagnostics

View source on GitHub

Generates model diagnostics plots from the Meridian model fitting.

  meridian 
 . 
 analysis 
 . 
 visualizer 
 . 
 ModelDiagnostics 
 ( 
 meridian 
 : 
   meridian 
 . 
 model 
 . 
 model 
 . 
 Meridian 
 
 
 , 
 use_kpi 
 : 
 bool 
 = 
 False 
 ) 
 

Methods

plot_prior_and_posterior_distribution

View source

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

Plots prior and posterior distributions for a model parameter.

plot_rhat_boxplot

View source

  plot_rhat_boxplot 
 () 
 -> 
 alt 
 . 
 Chart 
 

Plots the R-hat box plot.

Visual summary of the Gelman & Rubin (1992) potential scale reduction for chain convergence, commonly referred to as R-hat. It is a convergence diagnostic measure that measures the degree to which variance (of the means) between chains exceeds what you would expect if the chains were identically distributed. Values close to 1.0 indicate convergence. R-hat < 1.2 indicates approximate convergence and is a reasonable threshold for many problems (Brooks & Gelman, 1998).

There is a single R-hat value for each model parameter. The box plot summarizes the distribution of R-hat values across indices. For example, the box corresponding to beta_gm summarizes the distribution of R-hat values across both the geo index g and the channel index m .

The R-hat is not defined for any parameters that have deterministic priors, so these parameters are not shown on the boxplot.

predictive_accuracy_table

View source

  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 
 

Displays the predictive accuracy of the DataFrame.