meridian.analysis.optimizer.OptimizationResults

Alocação otimizada de orçamento.

meridian.analysis.optimizer.OptimizationResults(
    meridian: meridian.model.model.Meridian,
    analyzer: meridian.analysis.analyzer.Analyzer,
    use_posterior: bool,
    use_optimal_frequency: bool,
    spend_ratio: np.ndarray,
    spend_bounds: tuple[np.ndarray, np.ndarray],
    _nonoptimized_data: xr.Dataset,
    _nonoptimized_data_with_optimal_freq: xr.Dataset,
    _optimized_data: xr.Dataset,
    _optimization_grid: xr.Dataset
)

É um objeto de classe de dados que contém a saída de conjuntos de dados de BudgetOptimizer. Esses conjuntos incluem:

  • nonoptimized_data: as métricas de orçamento não otimizadas (com base na frequência histórica).
  • nonoptimized_data_with_optimal_freq: as métricas de orçamento não otimizadas com base na frequência ideal.
  • optimized_data: as métricas otimizadas de orçamento.
  • optimization_grid: as informações da grade usadas para otimização.

As métricas (variáveis de dados) são: ROI, mROI, resultado incremental e CPIK.

Além disso, alguns valores intermediários e referências ao modelo e ao analisador ajustados da fonte também são armazenados aqui. Eles são úteis para visualização e depuração.

meridian O modelo do Meridian ajustado que foi usado para criar essa alocação de orçamento.
analyzer O analisador vinculado ao modelo acima.
use_posterior Indica se a distribuição a posteriori foi usada para otimizar o orçamento. Se for False, a distribuição a priori foi utilizada.
use_optimal_frequency Se a frequência ideal foi usada para otimizar o orçamento.
spend_ratio A proporção de gastos usada para ajustar as métricas não otimizadas de orçamento para as otimizadas.
spend_bounds Os limites de gastos usados para ajustar as métricas não otimizadas de orçamento para as otimizadas.
nonoptimized_data As métricas não otimizadas de orçamento (com base na frequência histórica).
nonoptimized_data_with_optimal_freq As métricas não otimizadas de orçamento (com base na frequência ideal).
optimized_data As métricas otimizadas de orçamento.
optimization_grid As informações da grade usadas para otimização.
template_env Um ambiente de modelo compartilhado vinculado a esse orçamento otimizado.

Métodos

get_response_curves

Ver código-fonte

get_response_curves() -> xr.Dataset

Calcula as curvas de resposta de acordo com o cenário de otimização do orçamento.

Esse método é um wrapper de Analyzer.response_curves(), que define os argumentos a seguir para serem consistentes com o cenário de otimização do orçamento especificado na chamada BudgetOptimizer.optimize() que retornou esse resultado. Especificamente, as seguintes:

  1. spend_multiplier corresponde à grade de otimização discreta, considerando o tamanho da etapa da grade e os limites de restrição no nível do canal.
  2. selected_times, by_reach e use_optimal_frequency correspondem aos valores definidos em BudgetOptimizer.optimize().

Retorna
Um conjunto de dados retornado por Analyzer.response_curves(), de acordo com o cenário de otimização do orçamento especificado na chamada BudgetOptimizer.optimize() que retornou esse resultado.

output_optimization_summary

Ver código-fonte

output_optimization_summary(
    filename: str, filepath: str
)

Gera e salva a saída de resumo da otimização em HTML.

plot_budget_allocation

Ver código-fonte

plot_budget_allocation(
    optimized: bool = True
) -> alt.Chart

Mostra um gráfico de pizza com o gasto alocado para cada canal.

Args
optimized Se for True, mostra o gasto otimizado. Se for False, mostra o gasto não otimizado.

Retorna
Um gráfico de pizza do Altair mostrando o gasto por canal.

plot_incremental_outcome_delta

Ver código-fonte

plot_incremental_outcome_delta() -> alt.Chart

Mostra um gráfico de cascata com a mudança no resultado incremental.

plot_response_curves

Ver código-fonte

plot_response_curves(
    n_top_channels: (int | None) = None
) -> alt.Chart

Plota as curvas de resposta, com restrições de gastos, de cada canal.

Args
n_top_channels Número opcional dos principais canais por gasto que serão incluídos. Por padrão, todos os canais são adicionados.

Retorna
Um gráfico do Altair que mostra as curvas de resposta com detalhes de otimização.

plot_spend_delta

Ver código-fonte

plot_spend_delta() -> alt.Chart

Mostra um gráfico de barras com a mudança otimizada no gasto por canal.

__eq__

__eq__(
    other
)

Retorna self==value.