meridian.data.input_data.InputData

Es un contenedor de datos publicitarios en un formato compatible con Meridian.

meridian.data.input_data.InputData(
    kpi: xr.DataArray,
    kpi_type: str,
    controls: xr.DataArray,
    population: xr.DataArray,
    revenue_per_kpi: (xr.DataArray | None) = None,
    media: (xr.DataArray | None) = None,
    media_spend: (xr.DataArray | None) = None,
    reach: (xr.DataArray | None) = None,
    frequency: (xr.DataArray | None) = None,
    rf_spend: (xr.DataArray | None) = None,
    organic_media: (xr.DataArray | None) = None,
    organic_reach: (xr.DataArray | None) = None,
    organic_frequency: (xr.DataArray | None) = None,
    non_media_treatments: (xr.DataArray | None) = None
)

kpi Un DataArray de dimensiones (n_geos, n_times) que contiene la variable dependiente no negativa. Suele ser la cantidad de unidades vendidas, pero puede ser cualquier métrica, como los ingresos o las conversiones.
kpi_type Es una cadena que indica si el KPI es de tipo 'revenue' o 'non-revenue'. Cuando el kpi_type es 'non-revenue' y revenue_per_kpi está presente, se usa la calibración del ROI y se ejecuta el análisis en función de los ingresos. Cuando no existe el revenue_per_kpi para el mismo kpi_type, se usa la calibración personalizada del ROI y el análisis se ejecuta en función del KPI.
controls Un DataArray de dimensiones (n_geos, n_times, n_controls) que contiene valores de variables de control.
population Un DataArray de dimensiones (n_geos,) que contiene la población de cada grupo. Esta variable se usa para ajustar el KPI y los medios para el modelado.
revenue_per_kpi Un DataArray opcional de dimensiones (n_geos, n_times) que contiene el importe promedio de los ingresos por unidad de KPI. Aunque el modelado se realiza en función de kpi, el análisis y la optimización del modelo se realizan en función de KPI * revenue_per_kpi (ingresos) si este valor está disponible. Si kpi corresponde a los ingresos, se pasa automáticamente un array de unos.
media Un DataArray opcional de dimensiones (n_geos, n_media_times, n_media_channels) que contiene valores de ejecución de medios no negativos. Suelen ser las impresiones, pero puede ser cualquier métrica, como el costo o los clics. Se requiere que n_media_times ≥ n_times, y los períodos finales de n_times deben alinearse con el período de kpi y controls. Debido a los efectos rezagados, recomendamos que la ventana de los medios incluya hasta max_lag períodos adicionales anteriores a esa ventana. Si n_media_times < n_times + max_lag, el modelo imputa correctamente el historial de medios como cero (sin ejecución de medios). Si n_media_times > n_times + max_lag, solo se usarán los períodos finales de n_times + max_lag para ajustar el modelo. media y media_spend deben contener la misma cantidad de canales de medios en el mismo orden. Si se pasa alguno de estos argumentos, el otro no es opcional.
media_spend Un DataArray opcional que contiene el costo asociado a cada canal de medios. Se usa como denominador para los cálculos del ROI. La forma del DataArray puede ser (n_geos, n_times, n_media_channels) o (n_media_channels,) si se agregan los datos en las dimensiones geo y time. Te recomendamos que el total de la inversión se alinee con el período de los datos de kpi y controls, que es el período durante el cual se calcula el resultado incremental del numerador del ROI. Sin embargo, ten en cuenta que el resultado incremental se ve influenciado por la ejecución de medios previa a este período, a través de los efectos rezagados, y que excluye los efectos rezagados posteriores al período de los medios ejecutados durante ese mismo período. En media y media_spend, debe haber la misma cantidad de canales de medios en el mismo orden. Si se pasa alguno de estos argumentos, el otro es obligatorio.
reach Es un DataArray opcional de dimensiones (n_geos, n_media_times, n_rf_channels) que contiene valores de reach no negativos. Se requiere que n_media_times ≥ n_times, y los períodos finales de n_times deben alinearse con la ventana de kpi y controls. La ventana debe incluir la ventana de los datos de kpi y controls, pero es opcional incluir los períodos rezagados anteriores a la ventana de los datos de kpi y controls. Si el alcance rezagado no se incluye o contiene menos de max_lag períodos, el modelo calculará la función Adstock suponiendo que no hubo ejecución del alcance antes del primer período observado. Te recomendamos que incluyas períodos n_times + max_lag, a menos que el valor de max_lag sea excesivamente grande. Si solo se usan datos de media, el valor de reach será None. reach, frequency y rf_spend deben contener la misma cantidad de canales de medios en el mismo orden. Si se pasa alguno de estos argumentos, los demás no se pueden omitir.
frequency Un DataArray opcional de dimensiones (n_geos, n_media_times, n_rf_channels) que contiene valores frequency no negativos. Se requiere que n_media_times ≥ n_times, y los períodos finales de n_times deben alinearse con la ventana de kpi y controls. La ventana debe incluir la ventana de los datos de kpi y controls, pero es opcional incluir los períodos rezagados anteriores a la ventana de los datos de kpi y controls. Si no se incluye la frecuencia rezagada, o si esta incluye menos de max_lag períodos, el modelo calculará la función Adstock suponiendo que no hubo ejecución de la frecuencia antes del primer período observado. Te recomendamos que incluyas períodos n_times + max_lag, a menos que el valor de max_lag sea excesivamente grande. Si solo se usan datos de media, el valor de frequency será None. reach, frequency y rf_spend deben contener la misma cantidad de canales de medios en el mismo orden. Si se pasa alguno de estos argumentos, los demás no se pueden omitir.
rf_spend Un DataArray opcional que contiene el costo de cada canal de alcance y frecuencia. Se usa como denominador para los cálculos del ROI. La forma del DataArray puede ser (n_rf_channels,), (n_geos, n_times, n_rf_channels) o (n_geos, n_rf_channels). Se deben agregar las inversiones de las diferentes dimensiones geográficas o de tiempo que no estén representadas. Te recomendamos que el total de la inversión se alinee con el período de los datos de kpi y controls, que es el período durante el cual se calcula el resultado incremental del numerador del ROI. Sin embargo, ten en cuenta que el resultado incremental se ve influenciado por la ejecución de medios previa a este período, a través de los efectos rezagados, y que excluye los efectos rezagados posteriores al período de los medios ejecutados durante ese mismo período. Si solo se usan datos de media, el valor de rf_spend será None. reach, frequency y rf_spend deben contener la misma cantidad de canales de medios en el mismo orden. Si se pasa alguno de estos argumentos, los demás no se pueden omitir.
organic_media Un DataArray opcional de dimensiones (n_geos, n_media_times, n_organic_media_channels) que contiene valores de medios orgánicos no negativos. Las variables de medios orgánicos son actividades de medios que no tienen un costo directo. Pueden incluir impresiones de boletines informativos, una entrada de blog, actividad en redes sociales o campañas por correo electrónico, pero pueden ser cualquier métrica, como los clics. Se requiere que n_media_times ≥ n_times, y los períodos finales de n_times deben alinearse con el período de kpi y controls. Debido a los efectos rezagados, recomendamos que la ventana de los medios orgánicos incluya hasta max_lag períodos adicionales anteriores a esa ventana. Si n_organic_media_times < n_times + max_lag, el modelo imputará correctamente el historial de medios orgánicos. Si n_organic_media_times > n_times + max_lag, solo se usarán los períodos finales de n_times + max_lag para ajustar el modelo.
organic_reach Un DataArray opcional de dimensiones (n_geos, n_media_times, n_organic_rf_channels) que contiene valores de alcance orgánico no negativos. Se requiere que n_media_times ≥ n_times, y los períodos finales de n_times se alineen con la ventana de kpi y controls. La ventana debe incluir la ventana de los datos de kpi y controls, pero es opcional incluir los períodos rezagados anteriores a la ventana de los datos de kpi y controls. Si el alcance rezagado no se incluye o contiene menos de max_lag períodos, el modelo calculará la función Adstock suponiendo que no hubo ejecución del alcance antes del primer período observado. Te recomendamos que incluyas los períodos n_times + max_lag, a menos que el valor de max_lag sea excesivamente alto. Si no se usan datos de frecuencia y alcance orgánicos, organic_reach y organic_frequency serán None. organic_reach y organic_frequency deben contener la misma cantidad de canales de medios en el mismo orden. Si se pasa alguno de estos argumentos, el otro no es opcional.
organic_frequency Un DataArray opcional de dimensiones (n_geos, n_media_times, n_organic_rf_channels) que contiene valores de frecuencia orgánica no negativos. Se requiere que n_media_times ≥ n_times, y los períodos finales de n_times se alineen con la ventana de kpi y controls. La ventana debe incluir la ventana de los datos de kpi y controls, pero es opcional incluir los períodos rezagados anteriores a la ventana de los datos de kpi y controls. Si no se incluye la frecuencia rezagada, o si esta incluye menos de max_lag períodos, el modelo calculará la función Adstock suponiendo que no hubo ejecución de la frecuencia antes del primer período observado. Te recomendamos que incluyas períodos n_times + max_lag, a menos que el valor de max_lag sea excesivamente alto. Si no se usan datos de frecuencia y alcance orgánicos, organic_frequency será None. organic_reach y organic_frequency deben contener la misma cantidad de canales de medios en el mismo orden. Si se pasa alguno de estos argumentos, el otro no es opcional.
non_media_treatments Un DataArray opcional de dimensiones (n_geos, n_times, n_non_media_channels) que contiene valores de variables de tratamiento que no son de medios. Las variables de tratamiento que no son de medios son actividades de marketing que realiza el anunciante y que no están directamente relacionadas con los medios. No tienen un costo de marketing directo asociado, pero, a diferencia de las variables de medios orgánicos, no hay efectos de Adstock ni Hill. Son diferentes de las variables de control, ya que se consideran variables de tratamiento del modelo causal. Entre los ejemplos, se incluyen publicar una promoción, el precio de un producto y un cambio en el empaque o el diseño de un producto.
control_variable Devuelve la dimensión de la variable de control.
geo Devuelve la dimensión geográfica.
media_channel Devuelve la dimensión del canal de medios.
media_spend_has_geo_dimension Comprueba si el array media_spend tiene una dimensión geográfica.
media_spend_has_time_dimension Comprueba si el array media_spend tiene una dimensión temporal.
media_time Devuelve las coordenadas de la dimensión temporal de los medios.
media_time_coordinates Devuelve la dimensión temporal de los medios en un wrapper TimeCoordinates.
non_media_channel Devuelve la dimensión del canal de tratamiento que no es de medios.
organic_media_channel Devuelve la dimensión del canal de medios orgánico.
organic_rf_channel Devuelve la dimensión del canal de RF orgánico.
rf_channel Devuelve la dimensión del canal de RF.
rf_spend_has_geo_dimension Comprueba si el array rf_spend tiene una dimensión geográfica.
rf_spend_has_time_dimension Comprueba si el array rf_spend tiene una dimensión temporal.
time Devuelve las coordenadas de la dimensión de tiempo.
time_coordinates Devuelve la dimensión temporal (KPI) en un wrapper TimeCoordinates.

Métodos

as_dataset

Ver código fuente

as_dataset() -> xr.Dataset

Devuelve los datos como un solo objeto xarray.Dataset.

get_all_channels

Ver código fuente

get_all_channels() -> np.ndarray

Devuelve todas las dimensiones del canal.

Este método muestra los nombres de los canales de medios, de RF, de medios orgánicos y los que no son de medios, concatenados en un solo array en ese orden.

get_all_media_and_rf

Ver código fuente

get_all_media_and_rf() -> np.ndarray

Devuelve todos los valores de ejecución de medios, incluidos los medios y los valores de RF.

Si se usaron datos de medios, alcance y frecuencia para el modelado, el resultado de alcance * frecuencia se concatena al final de los datos de medios.

Returns
np.ndarray con dimensiones (n_geos, n_media_times, n_channels) que contiene datos de medios o el resultado de alcance por frecuencia para cada media_channel o rf_channel

get_all_paid_channels

Ver código fuente

get_all_paid_channels() -> np.ndarray

Devuelve todas las dimensiones de canales pagados, incluidas las de medios y RF.

Si están presentes los canales de medios y RF, los canales de RF se concatenan al final de los canales de medios.

get_n_top_largest_geos

Ver código fuente

get_n_top_largest_geos(
    num_geos: int
) -> list[str]

Encuentra la cantidad especificada de las ubicaciones geográficas más grandes en términos de población.

Args
num_geos Es la cantidad de ubicaciones geográficas principales más grandes en términos de población.

Returns
Es una lista de la cantidad especificada de ubicaciones geográficas principales más grandes.

get_total_spend

Ver código fuente

get_total_spend() -> np.ndarray

Devuelve la inversión total, incluidos los valores de media_spend y rf_spend.

__eq__

__eq__(
    other
)

Devuelve self==value.

frequency None
media None
media_spend None
non_media_treatments None
organic_frequency None
organic_media None
organic_reach None
reach None
revenue_per_kpi None
rf_spend None