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 prior का इस्तेमाल किया जाता है.
media_effects_dist अलग-अलग इलाकों में मीडिया के अलग-अलग इफ़ेक्ट के डिस्ट्रिब्यूशन की जानकारी देने वाली स्ट्रिंग. इस एट्रिब्यूट का इस्तेमाल, राष्ट्रीय लेवल के मॉडल के साथ नहीं किया जाता. इस्तेमाल की जा सकने वाली वैल्यू: 'normal' या 'log_normal'. डिफ़ॉल्ट: 'log_normal'.
hill_before_adstock यह एक बूलियन वैल्यू है, जिससे पता चलता है कि Adstock फ़ंक्शन के पहले Hill फ़ंक्शन को लागू करना है या नहीं. डिफ़ॉल्ट क्रम में, Hill फ़ंक्शन के पहले Adstock फ़ंक्शन को लागू किया जाता है. यह आर्ग्युमेंट, आरएफ़ चैनलों पर लागू नहीं होता. डिफ़ॉल्ट: False.
max_lag यह एक पूर्णांक है, जो Adstock के हिसाब लगाने के लिए, लैग पीरियड की ज़्यादा से ज़्यादा संख्या (0 से ज़्यादा) दिखाता है. इसे None पर भी सेट किया जा सकता है, जो कि अनलिमिटेड मैक्स लैग के बराबर है. डिफ़ॉल्ट: 8.
unique_sigma_for_each_geo यह एक बूलियन वैल्यू है, जो यह बताती है कि हर भौगोलिक क्षेत्र के लिए, यूनीक रिज़ल्ट वैरिएंस का इस्तेमाल करना है या नहीं. अगर False है, तो सभी भौगोलिक क्षेत्रों के लिए एक ही अवशिष्ट वैरिएंस का इस्तेमाल किया जाता है. डिफ़ॉल्ट: False.
use_roi_prior (इस्तेमाल नहीं किया जाता, इसके बजाय paid_media_prior_type का इस्तेमाल करें) यह एक बोलियन वैल्यू है, जिससे पता चलता है कि पहले से मौजूद डेटा में, आरओआई के पहले से मौजूद डेटा और roi_m के पहले से मौजूद डेटा का इस्तेमाल करना है या नहीं. अगर False है, तो beta_m के लिए पहले से सेट किए गए वैल्यू का इस्तेमाल किया जाता है. डिफ़ॉल्ट: 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 एट्रिब्यूट का इस्तेमाल किया जाता है. इन एट्रिब्यूट का इस्तेमाल, आरओआई या mROI के लिए, पहले से तय किए गए वैल्यू की जानकारी देने के लिए किया जाता है. साथ ही, PriorContainer.beta_m और PriorContainer.beta_rf एट्रिब्यूट को अनदेखा कर दिया जाएगा.
roi_calibration_period (n_media_times, n_media_channels) आकार का वैकल्पिक बूलियन ऐरे, जो time के सबसेट को दिखाता है. यह सबसेट, roi_m के आरओआई (या mROI) वैल्यू पर लागू होता है. अगर None है, तो सभी समय का इस्तेमाल किया जाता है. डिफ़ॉल्ट: None.
rf_roi_calibration_period (n_media_times, n_rf_channels) शेप का वैकल्पिक बूलियन ऐरे, जो time के सबसेट को दिखाता है. यह सबसेट, roi_rf के आरओआई (या mROI) वैल्यू पर लागू होता है. अगर None है, तो सभी समय का इस्तेमाल किया जाता है. डिफ़ॉल्ट: None.
knots यह एक वैकल्पिक पूर्णांक या पूर्णांकों की सूची है. इससे, समय के असर का अनुमान लगाने के लिए इस्तेमाल होने वाली नॉट का पता चलता है. जब knots पूर्णांकों की सूची होती है, तो उस सूची से गांठ की जगहें मिलती हैं. शून्य, पहली समयावधि में एक गाँठ, एक, दूसरी समयावधि में एक गाँठ, ..., और (n_times - 1), आखिरी समयावधि में एक गाँठ से जुड़ा होता है). आम तौर पर, हमारा सुझाव है कि आप 0 और (n_times - 1) में नॉट शामिल करें. हालांकि, ऐसा करना ज़रूरी नहीं है. जब knots कोई पूर्णांक होता है, तो समयावधि के दौरान, एक जैसे अंतर वाली जगहों पर नोड होते हैं. इनमें शून्य और (n_times - 1) पर मौजूद नोड भी शामिल हैं. जब knots1 होता है, तो सभी समयावधि के लिए एक ही सामान्य रिग्रेशन कोएफ़िशिएंट का इस्तेमाल किया जाता है. अगर knots को None पर सेट किया गया है, तो इस्तेमाल की गई नॉट की संख्या, भौगोलिक मॉडल के मामले में समयावधि की संख्या के बराबर होती है. इसका मतलब है कि हर समयावधि के लिए, रिग्रेशन गुणांक अलग-अलग होता है. अगर किसी नैशनल मॉडल के लिए knots को None पर सेट किया गया है, तो इस्तेमाल की गई नॉट की संख्या 1 होगी. डिफ़ॉल्ट: None.
baseline_geo बेसलाइन जियो के लिए, वैकल्पिक पूर्णांक या स्ट्रिंग. जियो के डमी कोड में, बेसलाइन जियो को रेफ़रंस जियो माना जाता है. बेसलाइन जियो के अलावा अन्य जियो के लिए, tau_g इंडिकेटर वैरिएबल होता है. इसका मतलब है कि उनका पहले का वैरिएंस, बेसलाइन जियो से ज़्यादा होता है. None पर सेट होने पर, सबसे ज़्यादा जनसंख्या वाले इलाके का इस्तेमाल आधारभूत रेफ़रंस के तौर पर किया जाता है. डिफ़ॉल्ट: None.
holdout_id भौगोलिक लेवल के मॉडल के लिए डाइमेंशन (n_geos, n_times) या राष्ट्रीय मॉडल के लिए (n_times,) का वैकल्पिक बूलियन टेंसर. इससे पता चलता है कि कौनसे अवलोकन, होल्डआउट सैंपल का हिस्सा हैं, जिन्हें ट्रेनिंग सैंपल से बाहर रखा गया है. ट्रेनिंग सैंपल से सिर्फ़ केपीआई डेटा को बाहर रखा जाता है. मीडिया डेटा अब भी शामिल किया जाता है, क्योंकि इससे आने वाले हफ़्तों के लिए विज्ञापन स्टॉक पर असर पड़ सकता है. अगर use_roi_prior=True जैसे "आरओआई के पूर्वानुमान" का इस्तेमाल किया जाता है, तो roi_m पैरामीटर सभी भौगोलिक क्षेत्रों और समय के आरओआई से जुड़े होते हैं. भले ही, वे होल्डआउट सैंपल में शामिल हों.
control_population_scaling_id डाइमेंशन (n_controls,) का वैकल्पिक बूलियन टेंसर, जो उन कंट्रोल वैरिएबल के बारे में बताता है जिनके लिए कंट्रोल वैल्यू को जनसंख्या के हिसाब से स्केल किया जाएगा. अगर None है, तो किसी भी कंट्रोल वैरिएबल को जनसंख्या के हिसाब से स्केल नहीं किया जाता. डिफ़ॉल्ट: None.
non_media_population_scaling_id डाइमेंशन (n_non_media_channels,) का वैकल्पिक बूलियन टेंसर, जो उन नॉन-मीडिया वैरिएबल के बारे में बताता है जिनके लिए नॉन-मीडिया वैल्यू को जनसंख्या के हिसाब से स्केल किया जाएगा. अगर None है, तो नॉन-मीडिया वैरिएबल को जनसंख्या के हिसाब से स्केल नहीं किया जाता. डिफ़ॉल्ट: None.

तरीके

__eq__

__eq__(
    other
)

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
use_roi_prior True