BaseMMM#

class pymc_marketing.mmm.mmm.BaseMMM(date_column=FieldInfo(annotation=NoneType, required=True, description='Column name of the date variable.'), channel_columns=FieldInfo(annotation=NoneType, required=True, description='Column names of the media channel variables.', metadata=[MinLen(min_length=1)]), adstock=FieldInfo(annotation=NoneType, required=True, description='Type of adstock transformation to apply.'), saturation=FieldInfo(annotation=NoneType, required=True, description='Type of saturation transformation to apply.'), time_varying_intercept=FieldInfo(annotation=NoneType, required=False, default=False, description='Whether to consider time-varying intercept.'), time_varying_media=FieldInfo(annotation=NoneType, required=False, default=False, description='Whether to consider time-varying media contributions.'), model_config=FieldInfo(annotation=NoneType, required=False, default=None, description='Model configuration.'), sampler_config=FieldInfo(annotation=NoneType, required=False, default=None, description='Sampler configuration.'), validate_data=FieldInfo(annotation=NoneType, required=False, default=True, description='Whether to validate the data before fitting to model'), control_columns=None, yearly_seasonality=None, adstock_first=FieldInfo(annotation=NoneType, required=False, default=True, description='Whether to apply adstock first.'), dag=FieldInfo(annotation=NoneType, required=False, default=None, description='Optional DAG provided as a string Dot format for causal identification.'), treatment_nodes=FieldInfo(annotation=NoneType, required=False, default=None, description='Column names of the variables of interest to identify causal effects on outcome.'), outcome_node=FieldInfo(annotation=NoneType, required=False, default=None, description='Name of the outcome variable.'), scaling=FieldInfo(annotation=NoneType, required=False, default=None, description='Scaling configuration for the model.'))[fuente]#

Clase base para un modelo de mezcla de medios que utiliza Adstock Retrasado y Saturación Logística (ver [1].

Referencias

[1]

Jin, Yuxue, et al. «Métodos bayesianos para la modelización de mezcla de medios con efectos de arrastre y forma.» (2017).

Métodos

BaseMMM.__init__([date_column, ...])

Defina el método constructor.

BaseMMM.approximate_fit(X[, y, barra de progreso, ...])

Ajuste un modelo utilizando Inferencia Variacional y devuelva InferenceData.

BaseMMM.attrs_to_init_kwargs(attrs)

Convertir atributos a kwargs de inicialización.

BaseMMM.build_from_idata(idata)

Construir el modelo a partir del objeto InferenceData.

BaseMMM.build_model(X, y, **kwargs)

Construya un modelo probabilístico utilizando PyMC para el modelado de mezcla de marketing.

BaseMMM.channel_contribution_forward_pass(...)

Evalúe la contribución del canal para unos datos de canal dados y un modelo ajustado, es decir.

BaseMMM.compute_channel_contribution_original_scale([previo])

Calcule las contribuciones del canal en la escala original de la variable objetivo.

BaseMMM.compute_mean_contributions_over_time([...])

Obtenga las contribuciones de cada canal a lo largo del tiempo.

BaseMMM.create_fit_data(X, y)

Cree el grupo fit_data basado en los datos de entrada.

BaseMMM.create_idata_attrs()

Cree atributos para los datos de inferencia.

BaseMMM.fit(X[, y, barra_de_progreso, semilla_aleatoria])

Ajuste un modelo utilizando los datos pasados como parámetro.

BaseMMM.forward_pass(x)

Transformar la entrada del canal en las contribuciones objetivo de cada canal.

BaseMMM.get_channel_contribution_share_samples([anterior])

Obtenga la participación de las contribuciones del canal en la escala original de la variable objetivo.

BaseMMM.get_errors([original_scale])

Obtener la distribución posterior de errores del modelo.

BaseMMM.get_target_transformer()

Devuelve la tubería del transformador objetivo utilizada para el preprocesamiento de la variable objetivo.

BaseMMM.graphviz(**kwargs)

Obtenga la representación graphviz del modelo.

BaseMMM.idata_to_init_kwargs(idata)

Cree la configuración del modelo y la configuración del muestreador a partir de InferenceData a argumentos de palabra clave.

BaseMMM.load(fname[, check])

Cree una instancia de ModelBuilder a partir de un archivo.

BaseMMM.load_from_idata(idata[, verificar])

Cree una instancia de ModelBuilder a partir de un objeto InferenceData.

BaseMMM.plot_channel_contribution_share_hdi([...])

Trace la proporción de contribuciones del canal en un gráfico de bosque.

BaseMMM.plot_components_contributions(...)

Trace la variable objetivo y los componentes del modelo predictivo posterior.

BaseMMM.plot_errors([escala_original, ax])

Grafique los errores del modelo tomando la diferencia entre los valores reales y los predichos.

BaseMMM.plot_grouped_contribution_breakdown_over_time([...])

Trace un gráfico de área de series temporales para todas las contribuciones del canal.

BaseMMM.plot_posterior_predictive([...])

Trace la distribución predictiva posterior del ajuste del modelo.

BaseMMM.plot_prior_predictive([...])

Trace la distribución predictiva previa a partir del ajuste del modelo.

BaseMMM.plot_prior_vs_posterior(var_name[, ...])

Trace la distribución previa frente a la distribución posterior para una variable especificada en un diseño de cuadrícula de 3 columnas.

BaseMMM.plot_waterfall_components_decomposition([...])

Cree un gráfico de cascada.

BaseMMM.post_sample_model_transformation()

Transformación del modelo posterior a la muestra para almacenar el estado de HSGP a partir del ajuste.

BaseMMM.predict([X, extend_idata])

Utilice un modelo para predecir sobre datos no vistos y devuelva la predicción puntual de todas las muestras.

BaseMMM.predict_posterior([X, extend_idata, ...])

Generar muestras predictivas posteriores en datos no vistos.

BaseMMM.predict_proba([X, extend_idata, ...])

Alias para predict_posterior, por consistencia con los estimadores probabilísticos de scikit-learn.

BaseMMM.preprocess(objetivo, datos)

Preprocese los datos proporcionados de acuerdo con el objetivo especificado.

BaseMMM.sample_posterior_predictive([X, ...])

Muestra de la distribución predictiva posterior del modelo.

BaseMMM.sample_prior_predictive([X, y, ...])

Muestra de la distribución predictiva previa del modelo.

BaseMMM.save(fname, **kwargs)

Guarde los datos de inferencia del modelo en un archivo.

BaseMMM.set_idata_attrs([idata])

Establecer atributos en un objeto InferenceData.

BaseMMM.table(**model_table_kwargs)

Obtenga la tabla resumen del modelo.

BaseMMM.validate(objetivo, datos)

Valide los datos de entrada según el tipo de destino especificado.

BaseMMM.validate_channel_columns(datos)

Valide las columnas del canal.

BaseMMM.validate_date_col(datos)

Valide la columna de fecha.

BaseMMM.validate_target(datos)

Valide la columna objetivo.

Atributos

default_model_config

Defina la configuración del modelo predeterminado.

default_sampler_config

Configuración de muestreador predeterminada para el modelo.

fit_result

Obtenga el resultado de ajuste posterior.

id

Generar un valor hash único para el modelo.

methods

Obtenga todos los métodos del objeto.

output_var

Defina la variable objetivo para el modelo.

posterior

posterior_predictive

predictions

preprocessing_methods

Una propiedad que proporciona métodos de preprocesamiento para las características ("X") y la variable objetivo ("y").

prior

prior_predictive

validation_methods

Una propiedad que proporciona métodos de validación para las características ("X") y la variable objetivo ("y").

version

model

idata

sampler_config

model_config

date_column

channel_columns