meridian.model.spec.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
)

این کلاس شامل تمام پارامترهای مدل است که بین اجراهای مریدین تغییر نمی کند.

prior یک شی PriorDistribution که توزیع قبلی هر مجموعه از پارامترهای مدل را مشخص می کند. توزیع برای یک بردار از پارامترها (به عنوان مثال، alpha_m ) می تواند به عنوان یک توزیع اسکالر یا یک توزیع برداری ارسال شود. اگر یک توزیع اسکالر ارسال شود، به شکل واقعی بردار پارامتر پخش می شود. توجه داشته باشید که PriorDistribution حاوی توزیع‌هایی برای roi_m و beta_m است، اما فقط یکی از آنها استفاده می‌شود. اگر use_roi_prior روی True تنظیم شده باشد، roi_m prior استفاده می شود. در غیر این صورت beta_m prior استفاده می شود.
media_effects_dist رشته ای برای مشخص کردن توزیع جلوه های تصادفی رسانه در سراسر جغرافیا. این ویژگی با یک مدل در سطح ملی استفاده نمی شود. مقادیر مجاز: 'normal' یا 'log_normal' . پیش‌فرض: 'log_normal' .
hill_before_adstock یک بولی که نشان می دهد به جای ترتیب پیش فرض Adstock قبل از هیل، تابع Hill قبل از تابع Adstock اعمال شود یا خیر. این استدلال برای کانال های RF صدق نمی کند. پیش فرض: False .
max_lag یک عدد صحیح که نشان‌دهنده حداکثر تعداد دوره‌های تاخیر (≥ 0 ) برای درج در محاسبه Adstock است. همچنین می توان آن را روی None تنظیم کرد که معادل حداکثر تاخیر بی نهایت است. پیش فرض: 8 .
unique_sigma_for_each_geo یک بولی که نشان می دهد آیا باید از یک واریانس باقیمانده منحصر به فرد برای هر جغرافیایی استفاده کرد یا خیر. اگر False باشد، یک واریانس تک باقیمانده برای همه زمین‌ها استفاده می‌شود. پیش فرض: False .
use_roi_prior یک بولی که نشان می‌دهد آیا باید از roi_m ROI استفاده کرد یا نه. اگر False ، از پیشین در beta_m در پیشین استفاده می شود. پیش فرض: True .
roi_calibration_period یک آرایه بولی اختیاری از شکل (n_media_times, n_media_channels) که زیرمجموعه time را برای کالیبراسیون ROI رسانه نشان می‌دهد. اگر None ، همه زمان‌ها برای کالیبراسیون ROI رسانه استفاده می‌شود. پیش فرض: None .
rf_roi_calibration_period یک آرایه بولی اختیاری از شکل (n_media_times, n_rf_channels) که زیرمجموعه time برای کالیبراسیون ROI دسترسی و فرکانس را نشان می‌دهد. اگر None ، همه زمان‌ها برای کالیبراسیون ROI رسانه استفاده می‌شود. پیش فرض: None .
knots یک عدد صحیح اختیاری یا لیستی از اعداد صحیح که گره های مورد استفاده برای تخمین اثرات زمان را نشان می دهد. هنگامی که knots لیستی از اعداد صحیح هستند، مکان گره ها توسط آن لیست ارائه می شود. صفر مربوط به یک گره در اولین دوره زمانی، یک مربوط به یک گره در دوره زمانی دوم، ...، و (n_times - 1) مربوط به یک گره در آخرین دوره زمانی است. به طور معمول، توصیه می کنیم گره ها را در 0 و (n_times - 1) قرار دهید، اما این مورد نیاز نیست. وقتی knots یک عدد صحیح هستند، پس گره هایی با مکان های مساوی در طول دوره های زمانی وجود دارند (شامل گره های صفر و (n_times - 1) . وقتی knots 1 است، یک ضریب رگرسیون مشترک برای همه دوره های زمانی استفاده می شود. اگر knots knots None None می شوند، سپس تعداد گره های استفاده شده برابر است با تعداد دوره های زمانی در مورد یک مدل جغرافیایی، این معادل است با هر دوره زمانی که ضریب رگرسیون خاص خود را داشته باشد از یک مدل ملی، تعداد گره های استفاده شده 1 است: None .
baseline_geo یک عدد صحیح اختیاری یا یک رشته برای خط پایه جغرافیایی. جغرافیای پایه به عنوان جغرافیای مرجع در رمزگذاری ساختگی geos در نظر گرفته می شود. geos غیر پایه دارای یک متغیر نشانگر tau_g متناظر هستند، به این معنی که آنها واریانس قبلی بالاتری نسبت به جغرافیای پایه دارند. وقتی روی None تنظیم شود، جغرافیایی با بیشترین جمعیت به عنوان خط پایه استفاده می شود. پیش فرض: None .
holdout_id تانسور بولی اختیاری ابعاد (n_geos, n_times) برای یک مدل سطح جغرافیایی یا (n_times,) برای یک مدل ملی، که نشان می‌دهد کدام مشاهدات بخشی از نمونه نگهدارنده هستند، که از نمونه آموزشی حذف شده‌اند. فقط داده‌های KPI یا درآمد (تاثیر) از نمونه آموزشی حذف می‌شوند. داده‌های رسانه همچنان گنجانده شده است زیرا می‌تواند بر Adstock برای هفته‌های بعدی تأثیر بگذارد. اگر از "ROI priors" استفاده شود، مانند use_roi_prior=True ، آنگاه پارامترهای roi_m با ROI همه مکان‌ها و زمان‌ها، حتی موارد موجود در نمونه نگهدارنده مطابقت دارد.
control_population_scaling_id یک تانسور بولی اختیاری بعد (n_controls,) که متغیرهای کنترلی را نشان می‌دهد که مقدار کنترل برای آن‌ها بر اساس جمعیت مقیاس‌بندی می‌شود. اگر None ، هیچ متغیر کنترلی بر اساس جمعیت مقیاس بندی نمی شود. پیش فرض: None .

روش ها

__eq__

__eq__(
    other
)

بازگشت به خود == ارزش.

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_calibration_period None
roi_calibration_period None
unique_sigma_for_each_geo False
use_roi_prior True