меридиан.модель.спец.ModelSpec

Параметры спецификации модели для Меридиана.

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,
    use_roi_prior: bool = True,
    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
)

Этот класс содержит все параметры модели, которые не меняются между запусками Meridian.

prior Объект PriorDistribution , определяющий априорное распределение каждого набора параметров модели. Распределение вектора параметров (например, alpha_m ) можно передать либо как скалярное, либо как векторное распределение. Если передается скалярное распределение, оно транслируется в фактическую форму вектора параметров. Обратите внимание, что PriorDistribution содержит дистрибутивы как для roi_m , так и beta_m , но используется только один из них. Если use_roi_prior установлено значение True , используется предшествующий roi_m . В противном случае используется предшествующий beta_m .
media_effects_dist Строка, определяющая распределение случайных эффектов мультимедиа по регионам. Этот атрибут не используется с моделью национального уровня. Допустимые значения: 'normal' или 'log_normal' . По умолчанию: 'log_normal' .
hill_before_adstock Логическое значение, указывающее, следует ли применять функцию Hill перед функцией Adstock вместо стандартного порядка Adstock перед Hill. Этот аргумент не применим к радиочастотным каналам. По умолчанию: False .
max_lag Целое число, указывающее максимальное количество периодов задержки (≥ 0 ), которое можно включить в расчет Adstock. Также может быть установлено значение None , что эквивалентно бесконечной максимальной задержке. По умолчанию: 8 .
unique_sigma_for_each_geo Логическое значение, указывающее, следует ли использовать уникальную остаточную дисперсию для каждого географического региона. Если False , то для всех географических регионов используется одна остаточная дисперсия. По умолчанию: False .
use_roi_prior Логическое значение, указывающее, использовать ли априорные значения ROI и априорные значения для roi_m в априорных значениях. Если False , то используется предшествующий уровень beta_m в предшествующем. По умолчанию: True .
roi_calibration_period Необязательный логический массив формы (n_media_times, n_media_channels) указывающий подмножество time для калибровки рентабельности инвестиций в медиа. Если None , для калибровки рентабельности инвестиций в среду используется все время. По умолчанию: None .
rf_roi_calibration_period Необязательный логический массив формы (n_media_times, n_rf_channels) указывающий подмножество time для калибровки охвата и частоты ROI. Если None , для калибровки рентабельности инвестиций в среду используется все время. По умолчанию: None .
knots Необязательное целое число или список целых чисел, обозначающих узлы, используемые для оценки временных эффектов. Если knots представляют собой список целых чисел, местоположения узлов предоставляются этим списком. Ноль соответствует узлу в первый период времени, единица соответствует узлу во второй период времени, ... и (n_times - 1) соответствует узлу в последний период времени). Обычно мы рекомендуем включать узлы в значениях 0 и (n_times - 1) , но это не обязательно. Если knots является целым числом, то существуют узлы с местоположениями, равномерно распределенными по периодам времени (включая узлы в нуле и (n_times - 1) . Когда knots равны 1 , для всех периодов времени используется один общий коэффициент регрессии. Если knots установлено значение None , то количество используемых узлов равно количеству периодов времени в случае геомодели. Это эквивалентно тому, что каждый период времени имеет свой собственный коэффициент регрессии. Если в данном случае knots установлено значение None национальной модели, то количество используемых узлов равно 1 По умолчанию: None .
baseline_geo Необязательное целое число или строка для базового географического положения. Базовая геолокация рассматривается как эталонная геолокация в фиктивной кодировке геолокации. Небазовые географические регионы имеют соответствующую индикаторную переменную tau_g , что означает, что они имеют более высокую априорную дисперсию, чем базовый географический регион. Если установлено значение None , в качестве базового используется регион с наибольшей численностью населения. По умолчанию: None .
holdout_id Необязательный логический тензор размеров (n_geos, n_times) для модели географического уровня или (n_times,) для национальной модели, указывающий, какие наблюдения являются частью контрольной выборки, а какие исключены из обучающей выборки. Из обучающей выборки исключаются только данные KPI или дохода (влияния). Данные СМИ по-прежнему включены, поскольку они могут повлиять на Adstock в последующие недели. Если используются «априорные значения рентабельности инвестиций», например use_roi_prior=True , то параметры roi_m соответствуют рентабельности инвестиций для всех географических регионов и времен, даже тех, которые находятся в контрольной выборке.
control_population_scaling_id Необязательный логический тензор размерности (n_controls,) указывающий управляющие переменные, для которых управляющее значение будет масштабироваться по численности населения. Если None , никакие управляющие переменные не масштабируются по совокупности. По умолчанию: None .

Методы

__eq__

__eq__(
    other
)

Вернуть значение self==.

baseline_geo None
control_population_scaling_id None
Hill_before_adstock False
Holdout_id None
узлы None
max_lag 8
media_effects_dist 'log_normal'
rf_roi_калибровка_период None
roi_калибровка_период None
unique_sigma_for_each_geo False
use_roi_prior True