meridian.model.spec.ModelSpec

Parâmetros de especificação do modelo para o Meridian.

meridian.model.spec.ModelSpec(
    prior: meridian.model.prior_distribution.PriorDistribution = dataclasses.field(default_factory=prior_distribution.PriorDistribution),
    media_effects_dist: str = constants.MEDIA_EFFECTS_LOG_NORMAL,
    hill_before_adstock: bool = False,
    max_lag: (int | None) = 8,
    unique_sigma_for_each_geo: bool = False,
    paid_media_prior_type: str = constants.PAID_MEDIA_PRIOR_TYPE_ROI,
    roi_calibration_period: (np.ndarray | None) = None,
    rf_roi_calibration_period: (np.ndarray | None) = None,
    knots: (int | list[int] | None) = None,
    baseline_geo: (int | str | None) = None,
    holdout_id: (np.ndarray | None) = None,
    control_population_scaling_id: (np.ndarray | None) = None,
    non_media_population_scaling_id: (np.ndarray | None) = None
)

Esta classe contém todos os parâmetros do modelo que não mudam entre as execuções do Meridian.

prior Um objeto PriorDistribution que especifica a distribuição a priori de cada conjunto de parâmetros do modelo. A distribuição de um vetor de parâmetros (por exemplo, alpha_m) pode ser transmitida como escalar ou vetorial. Se for escalar, ela será transmitida para a forma real do vetor de parâmetro. Consulte paid_media_prior_type para mais detalhes.
media_effects_dist Uma string para especificar a distribuição de efeitos aleatórios de mídia em várias regiões geográficas. Esse atributo não é usado com um modelo nacional. Valores permitidos: 'normal' ou 'log_normal'. Padrão: 'log_normal'.
hill_before_adstock Um booleano que indica se a função Hill deve ser aplicada antes da Adstock, em vez da ordem padrão Adstock e depois Hill. Esse argumento não se aplica a canais de RF. Padrão: False.
max_lag Um número inteiro que indica a quantidade máxima de períodos de atraso (≥ 0) a incluir no cálculo de Adstock. Também pode ser definido como None, o que equivale a atraso máximo infinito. Padrão: 8.
unique_sigma_for_each_geo Um booleano que indica se é necessário usar uma variância residual exclusiva para cada região. Se for False, uma única variância residual será usada para todas as regiões. Padrão: False.
paid_media_prior_type Uma string para especificar o tipo da distribuição a priori dos coeficientes de mídia. Valores permitidos: 'roi', 'mroi' e 'coefficient'. Padrão: 'roi'. O objeto PriorDistribution contém as distribuições roi_m, mroi_m e beta_m, mas apenas uma delas é usada, dependendo do valor de paid_media_prior_type. Da mesma forma, PriorDistribution contém as distribuições roi_rf, mroi_rf e beta_rf, mas apenas uma delas é usada, dependendo do valor de paid_media_prior_type. Quando paid_media_prior_type é 'roi', os parâmetros PriorDistribution.roi_m e PriorDistribution.roi_rf são usados para especificar uma distribuição a priori no ROI. Quando paid_media_prior_type é 'mroi', os parâmetros PriorDistribution.mroi_m e PriorDistribution.mroi_rf são utilizados para definir uma distribuição a priori no mROI. Quando paid_media_prior_type é 'coefficient', os parâmetros PriorDistribution.beta_m e PriorDistribution.beta_rf são usados para especificar uma distribuição a priori nos parâmetros médios do coeficiente.
roi_calibration_period Uma matriz booleana opcional com o formato (n_media_times, n_media_channels) que indica o subconjunto de time aplicável ao valor de ROI da distribuição a priori de roi_m (ou o valor de mROI da distribuição a priori de mroi_m). Se for None, todos os períodos serão usados. Padrão: None.
rf_roi_calibration_period Uma matriz booleana opcional com o formato (n_media_times, n_rf_channels) que indica o subconjunto de time aplicável ao valor de ROI da distribuição a priori de roi_rf (ou o valor de mROI da distribuição a priori de mroi_rf). Se for None, todos os períodos serão usados. Padrão: None.
knots Um número inteiro ou uma lista de números inteiros (opcional) que indicam os nós usados para estimar os efeitos do tempo. Quando knots é uma lista de números inteiros, os locais dos nós são fornecidos por ela. "Zero" corresponde a um nó no primeiro período, "um" a um nó no segundo período, ..., e (n_times - 1) a um nó no último período. Normalmente, recomendamos incluir nós em 0 e (n_times - 1), mas isso não é obrigatório. Quando knots é um número inteiro, há nós com locais igualmente espaçados nos períodos, incluindo "zero" e (n_times - 1). Quando knots é 1, há um único coeficiente de regressão comum usado para todos os períodos. Se knots for definido como None, o número de períodos e nós usados será igual em modelos geográficos. Isso equivalente a cada período ter seu próprio coeficiente de regressão. Se knots for definido como None em modelos nacionais, o número de nós usados será 1. Padrão: None.
baseline_geo Um número inteiro ou uma string (opcional) para a região de base. Ela é tratada como a região geográfica de referência na codificação fictícia de regiões. As demais regiões têm uma variável de indicador tau_g correspondente e uma variância de distribuição a priori maior que a região de base. Quando definida como None, a região com a maior população é usada como base. Padrão: None.
holdout_id Tensor booleano opcional das dimensões (n_geos, n_times) para modelos geográficos ou (n_times,) para modelos nacionais, que indica quais observações fazem parte da amostra de validação e quais não estão na amostra de treinamento. Somente dados de KPI são excluídos da amostra de treinamento. Os dados de mídia ainda são incluídos porque podem afetar o Adstock nas semanas seguintes. Se as distribuições a priori de ROI forem usadas, os parâmetros roi_m corresponderão ao ROI de todas as regiões e períodos, inclusive da amostra de validação.
control_population_scaling_id Um tensor booleano opcional de dimensão (n_controls,) que indica para quais variáveis de controle o valor de controle será ajustado pela população. Se for None, nenhuma variável será ajustada. Padrão: None.
non_media_population_scaling_id Um tensor booleano opcional de dimensão (n_non_media_channels,) que indica para quais variáveis o valor será ajustado pela população. Se for None, nenhuma variável que não for de mídia será ajustada pela população. Padrão: None.

Métodos

__eq__

__eq__(
    other
)

Retorna self==value.

baseline_geo None
control_population_scaling_id None
hill_before_adstock False
holdout_id None
knots None
max_lag 8
media_effects_dist 'log_normal'
non_media_population_scaling_id None
paid_media_prior_type 'roi'
rf_roi_calibration_period None
roi_calibration_period None
unique_sigma_for_each_geo False