meridian.analysis.visualizer.ModelDiagnostics

Genera diagramas de diagnóstico del modelo a partir de la adaptación del modelo Meridian.

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

Métodos

plot_prior_and_posterior_distribution

Ver código fuente

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

Representa las distribuciones de probabilidades a priori y a posteriori de un parámetro del modelo.

Args
parameter	Es el nombre del parámetro del modelo que se representará. Si no se especifica ningún nombre, se muestra el parámetro de ROI de forma predeterminada.
num_geos	Es la cantidad de ubicaciones geográficas más grandes en términos de población que se mostrarán en los diagramas de parámetros a nivel geográfico. De forma predeterminada, solo se muestran las tres ubicaciones geográficas más grandes.
selected_times	Es una lista de períodos específicos que se representarán para los parámetros temporales. Estos períodos deben coincidir con los períodos de los datos. De forma predeterminada, se representan los primeros tres períodos.

Returns
Diagrama Altair que muestra las distribuciones de los parámetros

Raises
NotFittedModelError	El modelo no se ajustó.
ValueError	Un parameter no es un parámetro del modelo Meridian.

plot_rhat_boxplot

Ver código fuente

plot_rhat_boxplot() -> alt.Chart

Genera el diagrama de caja de R-hat.

Es un resumen visual de la reducción de escala potencial de Gelman y Rubin (1992) de la convergencia de cadenas, comúnmente conocida como R-hat. Es una medida de diagnóstico de la convergencia que mide el grado en que la varianza (de las medias) entre las cadenas supera lo que se esperaría si estas se distribuyeran de manera idéntica. Los valores cercanos a 1.0 son indicativos de la convergencia. Específicamente, un valor R-hat <1.2 indica una convergencia aproximada y es un umbral razonable para muchos problemas (Brooks y Gelman, 1998).

Cada parámetro del modelo tiene un solo valor de R-hat. El diagrama de caja resume la distribución de los valores R-hat en los índices. Por ejemplo, la caja correspondiente a beta_gm resume la distribución de los valores R-hat en el índice geográfico g y el índice de canales m.

El valor R-hat no se define para ningún parámetro que tenga distribuciones a priori determinísticas, por lo que estos parámetros no se muestran en el diagrama de caja.

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

Returns
Diagrama de Altair que muestra el diagrama de caja de R-hat por parámetro

Raises
NotFittedModelError	El modelo no se ajustó.
MCMCSamplingError	El muestreo de MCMC no convergió.

predictive_accuracy_table

Ver código fuente

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

Muestra la precisión predictiva del DataFrame.

Args
selected_geos	Es una lista opcional de un subconjunto de dimensiones geográficas que se pueden incluir. De forma predeterminada, se incluyen todas las ubicaciones geográficas. Las ubicaciones geográficas deben coincidir con los nombres de las dimensiones geográficas de meridian.InputData. Configura selected_geos o n_top_largest_geos, pero no ambos.
selected_times	Es una lista opcional de un subconjunto de dimensiones temporales que se pueden incluir. De forma predeterminada, se incluyen todos los períodos. Los períodos deben coincidir con las dimensiones temporales de meridian.InputData.
column_var	Es una cadena opcional que indica si se debe pivotar la tabla en función de los valores de metric, geo_granularity o evaluation_set. De forma predeterminada, column_var=None indica que las columnas metric, geo_granularity y value (junto con evaluation_set cuando holdout_id no es None) se muestran en el DataFrame no pivoteado que se devuelve.
batch_size	Es un número entero que representa la cantidad máxima de extracciones por cadena en cada lote. El cálculo se ejecuta en lotes para evitar el agotamiento de la memoria. Si se produce un error de memoria, intenta reducir batch_size. Por lo general, el cálculo será más rápido con valores de batch_size más grandes.

Returns
Un DataFrame que contiene los valores calculados de R_Squared, MAPE y wMAPE. Si holdout_id está presente, los datos se dividen en las subsecciones Train, Test y All Data, y evaluation_set se incluye como una columna en la transformación de conjunto de datos a DataFrame.