meridian.model.spec.ModelSpec

פרמטרים של מפרטי מודל ל-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,
    use_roi_prior: bool = True,
    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
)

הכיתה הזו מכילה את כל הפרמטרים של המודל שלא משתנים בין ההרצות של 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. הארגומנט הזה לא רלוונטי לערוצי RF. ברירת המחדל: False.
max_lag מספר שלם שמציין את מספר תקופות הזמן המרביות (0 ומעלה) שצריך לכלול בחישוב של Adstock. אפשר גם להגדיר את הערך None, שהוא שווה לעיכוב מקסימלי אינסופי. ברירת המחדל: 8.
unique_sigma_for_each_geo ערך בוליאני שמציין אם להשתמש בתנודות ייחודיות של נתונים שיורית לכל אזור גיאוגרפי. אם False, המערכת משתמשת בסטיית יתרה אחת לכל המיקומים הגיאוגרפיים. ברירת המחדל: False.
use_roi_prior (התכונה הוצאה משימוש. במקום זאת, יש להשתמש ב-paid_media_prior_type) משתנה בוליאני שמציין אם להשתמש ב-priors של ROI וב-prior של roi_m ב-prior. אם False, המערכת משתמשת ב-prior ב-beta_m ב-prior. ברירת המחדל: True.
paid_media_prior_type מחרוזת לציון הסוג הקודם של מקדמי המדיה. הערכים המותרים: 'roi', ‏ 'mroi', ‏ 'coefficient'. ברירת המחדל: 'roi'. אם הערך של paid_media_prior_type הוא 'coefficient', then thePriorContainer.beta_mandPriorContainer.beta_rfattributes are used to specify a prior on the coefficient mean parameters (and thePriorContainer.roi_mandPriorContainer.roi_rfattributes will be ignored). Ifpaid_media_prior_type' הוא 'roi' או 'mroi', המאפיינים PriorContainer.roi_m ו-PriorContainer.roi_rf משמשים לציון ערכים קודמים של החזר ה-ROI או החזר ה-ROI הממוצע, בהתאמה (והמאפיינים PriorContainer.beta_m ו-PriorContainer.beta_rf יימחקו).
roi_calibration_period מערך בוליאני אופציונלי בפורמט (n_media_times, n_media_channels) שמציין את קבוצת המשנה של time שעליה חל ערך החזר ה-ROI (או mROI) של roi_m הקודם. אם הערך הוא None, המערכת משתמשת בכל הזמנים. ברירת המחדל: None.
rf_roi_calibration_period מערך בוליאני אופציונלי בפורמט (n_media_times, n_rf_channels) שמציין את קבוצת המשנה של time שעליה חל ערך החזר ה-ROI (או החזר ה-ROI הממוצע) של roi_rf הקודם. אם הערך שלו הוא None, המערכת תשתמש בכל השעות. ברירת המחדל: None.
knots מספר שלם אופציונלי או רשימה של מספרים שלמים שמציינים את המהירות בקשרים לשעון (knots) ששימשו להערכת ההשפעות של הזמן. כש-knots היא רשימה של מספרים שלמים, רשימת המיקומים של הקשרים מסופקת על ידי הרשימה הזו. אפס מתאים לצומת בתקופת הזמן הראשונה, אחד מתאים לצומת בתקופת הזמן השנייה, וכן הלאה, ו-(n_times - 1) מתאים לצומת בתקופת הזמן האחרונה). בדרך כלל מומלץ לכלול צמתים ב-0 וב-(n_times - 1), אבל זה לא חובה. כש-knots הוא מספר שלם, יש צמתים במיקומים שמרווחים באופן שווה בין תקופות הזמן (כולל צמתים ב-0 וב-(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,) למודל ברמת המדינה, שמציינת אילו תצפיות הן חלק מדגימת ההחזקה (holdout), והן מוחרגות מדגימת האימון. רק נתוני מדדי ה-KPI יוחרגו מדגימת האימון. נתוני המדיה עדיין נכללים, כי הם יכולים להשפיע על מלאי שטחי הפרסום בשבועות הבאים. אם משתמשים ב'הנחות מוקדמות לגבי החזר ה-ROI', כמו use_roi_prior=True, הפרמטרים roi_m תואמים להחזר ה-ROI של כל המיקומים הגיאוגרפיים והזמנים, גם של אלה שבדגימת ההחזקה.
control_population_scaling_id טרנספורמציה אופציונלית של טנזור בוליאני בממד (n_controls,) שמציינת את משתני הבקרה שלגביהם ערך הבקרה יתכוונן לפי האוכלוסייה. אם None, לא מתבצע שינוי של משתני הבקרה לפי אוכלוסייה. ברירת המחדל: None.
non_media_population_scaling_id טרנספורמציית טינסור בוליאני אופציונלית של המאפיין (n_non_media_channels,), שמציינת את המשתנים שאינם מדיה שהערך שלהם יושווה לאוכלוסייה. אם None, אף משתנה שאינו משתנה מדיה לא מותאם לפי אוכלוסייה. ברירת המחדל: None.

Methods

__eq__

__eq__(
    other
)

הפונקציה מחזירה את הערך self==value.

baseline_geo None
control_population_scaling_id None
hill_before_adstock False
holdout_id None
צמתים 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
use_roi_prior True