meridian.data.input_data.InputData

Um contêiner para dados de publicidade em um formato compatível com o 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 Um DataArray de dimensões (n_geos, n_times) que contém a variável dependente não negativa. Normalmente, esse é o número de unidades vendidas, mas pode ser qualquer métrica, como receita ou conversões.
kpi_type Uma string que indica se o KPI é do tipo 'revenue' ou 'non-revenue'. Quando o kpi_type é 'non-revenue' e revenue_per_kpi existe, a calibragem do ROI é usada e a análise é executada na receita. Quando revenue_per_kpi não existe para o mesmo kpi_type, a calibragem personalizada do ROI é usada e a análise é executada no KPI.
controls Um DataArray de dimensões (n_geos, n_times, n_controls) que contém valores de variáveis de controle.
population Uma DataArray de dimensões (n_geos,) que contém a população de cada grupo. Essa variável é usada para dimensionar o KPI e a mídia para a modelagem.
revenue_per_kpi Um DataArray opcional de dimensões (n_geos, n_times) que contém o valor médio da receita por unidade de KPI. Embora a modelagem seja feita em kpi, a análise e otimização do modelo são feitas em KPI * revenue_per_kpi (receita), quando esse valor está disponível. Se kpi corresponder à receita, uma matriz desses valores será transmitida automaticamente.
media Uma DataArray opcional de dimensões (n_geos, n_media_times, n_media_channels) que contém valores de execução de mídia não negativos. Costuma ser impressões, mas pode ser qualquer métrica, como custo ou cliques. É obrigatório que n_media_times seja ≥ n_times, e os períodos finais n_times precisam estar alinhados com a janela temporal de kpi e controls. Devido aos efeitos atrasados, recomendamos que essa janela de tempo para mídia inclua até max_lag períodos adicionais anteriores. Se n_media_times < n_times + max_lag, o modelo atribui o histórico de mídia como zero (sem execução de mídia). Se n_media_times > n_times + max_lag, então apenas os períodos finais n_times + max_lag serão usados para ajustar o modelo. media e media_spend precisam conter o mesmo número de canais de mídia e na mesma ordem. Se um desses argumentos for transmitido, o outro não será opcional.
media_spend Um DataArray opcional que contém o custo de cada canal de mídia e é usado como denominador para os cálculos de ROI. O formato DataArray poderá ser (n_geos, n_times, n_media_channels) ou (n_media_channels,) se os dados forem agregados nas dimensões geo e time. Recomendamos que o total de gastos esteja alinhado à janela temporal dos dados kpi e controls, que é o período para o cálculo do resultado incremental do numerador do ROI. No entanto, o resultado incremental é influenciado pela execução de mídia anterior a essa janela por efeitos defasados e exclui os efeitos defasados além do período da mídia executada. media e media_spend precisam conter o mesmo número de canais de mídia e na mesma ordem. Se um desses argumentos for transmitido, o outro não será opcional.
reach Um DataArray opcional de dimensões (n_geos, n_media_times, n_rf_channels) que contém valores reach não negativos. É obrigatório que n_media_times seja ≥ n_times, e os períodos finais n_times precisam estar alinhados com a janela temporal de kpi e controls. Essa janela precisa incluir o intervalo de tempo dos dados kpi e controls, mas é opcional incluir períodos atrasados antes da janela dos dados kpi e controls. Se o alcance atrasado não for incluído ou incluir menos de max_lag períodos, o modelo vai calcular o Adstock supondo que a execução do alcance seja zero antes do primeiro período observado. Recomendamos incluir períodos n_times + max_lag, a menos que o valor de max_lag seja muito grande. Se apenas dados de media forem usados, reach será None. reach, frequency e rf_spend precisam conter o mesmo número de canais de mídia e na mesma ordem. Se um desses argumentos for transmitido, os outros não serão opcionais.
frequency Um DataArray opcional de dimensões (n_geos, n_media_times, n_rf_channels) que contém valores frequency não negativos. É obrigatório que n_media_times seja ≥ n_times, e os períodos finais n_times precisam estar alinhados com a janela temporal de kpi e controls. Essa janela precisa incluir o intervalo de tempo dos dados kpi e controls, mas é opcional incluir períodos atrasados antes da janela dos dados kpi e controls. Se a frequência atrasada não for incluída ou incluir menos de max_lag períodos, o modelo vai calcular o Adstock supondo que a execução de frequência seja zero antes do primeiro período observado. Recomendamos incluir períodos n_times + max_lag, a menos que o valor de max_lag seja muito grande. Se apenas dados media forem usados, frequency será None. reach, frequency e rf_spend precisam conter o mesmo número de canais de mídia e na mesma ordem. Se um desses argumentos for transmitido, os outros não serão opcionais.
rf_spend Um DataArray opcional que contém o custo de cada canal de alcance frequência e alcance e é usado como denominador para os cálculos de ROI. O formato DataArray pode ser (n_rf_channels,), (n_geos, n_times, n_rf_channels) ou (n_geos, n_rf_channels). O gasto precisa ser agregado em dimensões geográficas e/ou de tempo que não estão representadas. Recomendamos que o total de gastos esteja alinhado à janela temporal dos dados kpi e controls, que é o período para o cálculo do resultado incremental do numerador do ROI. No entanto, o resultado incremental é influenciado pela execução de mídia anterior a essa janela por efeitos atrasados e exclui os efeitos além do período da mídia executada. Se apenas dados media forem usados, rf_spend será None. reach, frequency e rf_spend precisam conter o mesmo número de canais de mídia e na mesma ordem. Se um desses argumentos for transmitido, os outros não serão opcionais.
organic_media Um DataArray opcional de dimensões (n_geos, n_media_times, n_organic_media_channels) que contém valores de mídia orgânica não negativos. As variáveis de mídia orgânica são atividades de mídia que não têm custo direto. Elas podem incluir impressões de newsletters, postagens do blog, atividades nas redes sociais ou campanhas por e-mail, mas podem ser qualquer métrica, como cliques. É obrigatório que n_media_times seja ≥ n_times, e os períodos finais n_times precisam estar alinhados com a janela de tempo de kpi e controls. Devido aos efeitos atrasados, recomendamos que essa janela de tempo para mídia inclua até max_lag períodos adicionais anteriores. Se n_organic_media_times < n_times + max_lag, o modelo atribui o histórico de mídia orgânica. Se n_organic_media_times > n_times + max_lag, então apenas os períodos finais n_times + max_lag serão usados para ajustar o modelo.
organic_reach Um DataArray opcional de dimensões (n_geos, n_media_times, n_organic_rf_channels) que contém valores de alcance orgânico não negativos. É obrigatório que n_media_times seja ≥ n_times, e os períodos finais n_times precisam estar alinhados com a janela de tempo de kpi e controls. Essa janela precisa incluir o intervalo de tempo dos dados kpi e controls, mas é opcional incluir períodos atrasados antes da janela de tempo dos dados kpi e controls. Se o alcance atrasado não for incluído ou incluir menos de max_lag períodos, o modelo vai calcular o Adstock supondo que a execução do alcance seja zero antes do primeiro período observado. Recomendamos incluir períodos n_times + max_lag, a menos que o valor de max_lag seja muito grande. Se nenhum dado de alcance e frequência orgânicos for usado, organic_reach e organic_frequency serão None. organic_reach e organic_frequency precisam conter o mesmo número de canais e na mesma ordem. Se um desses argumentos for transmitido, o outro não será opcional.
organic_frequency Um DataArray opcional de dimensões (n_geos, n_media_times, n_organic_rf_channels) que contém valores de frequência orgânica não negativa. É obrigatório que n_media_times seja ≥ n_times, e os períodos finais n_times precisam estar alinhados com a janela de tempo de kpi e controls. Essa janela precisa incluir o intervalo de tempo dos dados kpi e controls, mas é opcional incluir períodos atrasados antes da janela de tempo dos dados kpi e controls. Se a frequência atrasada não for incluída ou incluir menos de max_lag períodos, o modelo vai calcular o Adstock supondo que a execução de frequência seja zero antes do primeiro período observado. Recomendamos incluir períodos n_times + max_lag, a menos que o valor de max_lag seja muito grande. Se nenhum dado de alcance e frequência orgânicos for usado, organic_frequency será None. organic_reach e organic_frequency precisam conter o mesmo número de canais e na mesma ordem. Se um desses argumentos for transmitido, o outro não será opcional.
non_media_treatments Uma DataArray opcional de dimensões (n_geos, n_times, n_non_media_channels) que contém valores de variáveis de tratamento que não são de mídia. Variáveis de tratamento que não são de mídia são atividades de marketing realizadas pelo anunciante que não estão diretamente relacionadas à mídia. Elas não têm custo de marketing direto associado, mas, ao contrário das variáveis de mídia orgânica, não há efeitos de Adstock e Hill. Elas diferem das variáveis de controle porque são consideradas intervencionáveis e, portanto, são variáveis de tratamento no modelo causal. Alguns exemplos incluem a realização de uma promoção, o preço de um produto e uma mudança na embalagem e/ou no design de um produto.
control_variable Retorna a dimensão da variável de controle.
geo Retorna a dimensão geográfica.
media_channel Retorna a dimensão do canal de mídia.
media_spend_has_geo_dimension Verifica se a matriz media_spend tem uma dimensão geográfica.
media_spend_has_time_dimension Verifica se a matriz media_spend tem uma dimensão de tempo.
media_time Retorna as coordenadas da dimensão de tempo da mídia.
media_time_coordinates Retorna a dimensão de tempo da mídia em um wrapper TimeCoordinates.
non_media_channel Retorna a dimensão do canal de tratamentos que não são de mídia.
organic_media_channel Retorna a dimensão do canal de mídia orgânica.
organic_rf_channel Retorna a dimensão do canal de RF orgânicos.
rf_channel Retorna a dimensão do canal de RF.
rf_spend_has_geo_dimension Verifica se a matriz rf_spend tem uma dimensão geográfica.
rf_spend_has_time_dimension Verifica se a matriz rf_spend tem uma dimensão de tempo.
time Retorna as coordenadas da dimensão de tempo.
time_coordinates Retorna a dimensão de tempo (KPI) em um wrapper TimeCoordinates.

Métodos

as_dataset

Ver código-fonte

as_dataset() -> xr.Dataset

Retorna dados como um único objeto xarray.Dataset.

get_all_channels

Ver código-fonte

get_all_channels() -> np.ndarray

Retorna todas as dimensões do canal.

Esse método retorna nomes de canais de mídia, RF, mídia orgânica, RF orgânicos e que não são de mídia, concatenados em uma única matriz nessa ordem.

get_all_media_and_rf

Ver código-fonte

get_all_media_and_rf() -> np.ndarray

Retorna todos os valores de execução de mídia, incluindo mídia e RF.

Se a mídia, o alcance e a frequência foram usados para a modelagem, o alcance * frequência será concatenado ao final da mídia.

Retorna
np.ndarray com dimensões (n_geos, n_media_times, n_channels) que contêm mídia ou alcance * frequência para cada media_channel ou rf_channel.

get_all_paid_channels

Ver código-fonte

get_all_paid_channels() -> np.ndarray

Retorna todas as dimensões do canal, incluindo mídia e RF.

Se os canais de mídia e RF estiverem presentes, os canais de RF serão concatenados ao final dos canais de mídia.

get_n_top_largest_geos

Ver código-fonte

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

Encontra o número especificado das maiores regiões geográficas por população.

Args
num_geos O número de principais regiões geográficas a serem retornadas com base na população.

Retorna
Uma lista do número especificado das principais regiões.

get_total_spend

Ver código-fonte

get_total_spend() -> np.ndarray

Retorna o gasto total, incluindo media_spend e rf_spend.

__eq__

__eq__(
    other
)

Retorna 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