meridian.analysis.analyzer.analyzer

محاسبات را برای تجزیه و تحلیل داده های خام پس از برازش مدل اجرا می کند.

کلاس های کودک

class PerformanceData

روش ها

adstock_decay

مشاهده منبع

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

ارگ
confidence_level سطح اطمینان برای فواصل معتبر قبلی و پسین، به عنوان مقداری بین صفر و یک نمایش داده می شود.

برمی گرداند
Pandas DataFrame حاوی کانال، time_units ، توزیع، ci_hi ، ci_lo ، و mean برای تابع Adstock است.

baseline_summary_metrics

مشاهده منبع

معیارهای خلاصه پایه را برمی‌گرداند.

ارگ
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، همه جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری حاوی زیرمجموعه ای از زمان ها. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
aggregate_geos بولی. اگر True ، تأثیر مورد انتظار در تمام مناطق خلاصه می شود.
aggregate_times بولی. اگر True ، تأثیر مورد انتظار در تمام دوره‌های زمانی خلاصه می‌شود.
confidence_level سطح اطمینان برای فواصل معتبر معیارهای خلاصه رسانه، که به صورت مقداری بین صفر و یک نمایش داده می‌شود.
batch_size عدد صحیح نشان دهنده حداکثر کشش در هر زنجیره در هر دسته است. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
یک xr.Dataset با مختصات: metric ( mean ، median ، ci_low ، ci_highdistribution (قبلی، پسین) و شامل متغیرهای داده زیر است: baseline_impact ، pct_of_contribution .

cpik

مشاهده منبع

هزینه هر توزیع KPI افزایشی برای هر کانال را محاسبه می کند.

شمارشگر CPIK کل هزینه شده در کانال است. مخرج CPIK تغییر در KPI مورد انتظار زمانی است که هزینه یک کانال روی صفر تنظیم می شود و هزینه تمام کانال های دیگر بدون تغییر باقی می ماند.

ارگ
use_posterior بولی. اگر True ، توزیع پسین محاسبه می شود. در غیر این صورت، توزیع قبلی محاسبه می شود.
new_media تانسور اختیاری با رسانه. برای محاسبه CPIK استفاده می شود.
new_media_spend تانسور اختیاری با media_spend برای محاسبه CPIK.
new_reach تانسور اختیاری با دسترسی. برای محاسبه CPIK استفاده می شود.
new_frequency تانسور اختیاری با فرکانس. برای محاسبه CPIK استفاده می شود.
new_rf_spend تانسور اختیاری با rf_spend برای محاسبه CPIK.
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، همه جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری حاوی زیرمجموعه ای از زمان ها. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
aggregate_geos بولی. اگر True ، KPI مورد انتظار در تمام مناطق جمع می شود.
aggregate_times بولی. اگر True ، KPI مورد انتظار در تمام دوره های زمانی جمع می شود.
batch_size عدد صحیح نشان دهنده حداکثر کشش در هر زنجیره در هر دسته است. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
تانسور مقادیر CPIK با ابعاد (n_chains, n_draws, n_geos, n_times, (n_media_channels + n_rf_channels)) . اگر aggregate_geos=True یا aggregate_times=True باشد، ابعاد n_geos و n_times حذف می شوند.

expected_outcome

مشاهده منبع

نتیجه مورد انتظار قبلی یا پسین را محاسبه می کند.

این E(Impact|Media, Controls) را برای هر قرعه کشی پارامتر بعدی (یا قبلی) محاسبه می کند، جایی که Impact ("نتیجه") به revenue اشاره دارد اگر use_kpi=False ، یا kpi اگر use_kpi=True . هنگامی که revenue_per_kpi تعریف نشده است، use_kpi نمی تواند False باشد.

به‌طور پیش‌فرض، این نتیجه مورد انتظار را مشروط به رسانه و مقادیر کنترلی که شی Meridian با آن مقداردهی اولیه شده است، محاسبه می‌کند. کاربر همچنین می‌تواند مقادیر رسانه‌ای دیگر را تا زمانی که ابعاد مطابقت دارند و به طور مشابه برای کنترل‌ها ارسال کند. در اصل، نتیجه مورد انتظار را می‌توان با سایر ابعاد زمانی (مثلاً پیش‌بینی‌های آینده) محاسبه کرد، اما به دلیل پیچیدگی‌های اضافی که معرفی می‌کند، با این روش مجاز نیست:

  1. اطلاعات مربوط به قیمت (درآمد به ازای هر KPI) نیز مورد نیاز است.
  2. اگر مدل دارای پارامترهای اثر هفتگی باشد، به روشی برای تخمین یا پیش‌بینی این اثرات برای دوره‌های زمانی خارج از پنجره داده‌های آموزشی نیاز است.

ارگ
use_posterior بولی. اگر True ، توزیع پسین نتیجه مورد انتظار محاسبه می شود. در غیر این صورت، توزیع قبلی محاسبه می شود.
new_media تانسور اختیاری با رسانه مطابق با ابعاد.
new_reach تانسور اختیاری با دستیابی منطبق بر ابعاد.
new_frequency تانسور اختیاری با فرکانس تطبیق ابعاد.
new_controls تانسور اختیاری با کنترل‌های تطبیق ابعاد.
selected_geos فهرست اختیاری شامل زیرمجموعه ای از جغرافیایی که باید شامل شود. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری شامل زیرمجموعه ای از تاریخ ها برای گنجاندن. مقادیر پذیرفته شده در اینجا باید با مختصات بعد زمانی از InputData.time مطابقت داشته باشد. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
aggregate_geos بولی. اگر True ، نتیجه مورد انتظار در تمام مناطق جمع می شود.
aggregate_times بولی. اگر True ، نتیجه مورد انتظار در تمام دوره های زمانی جمع می شود.
inverse_transform_outcome بولی. اگر True ، نتیجه مورد انتظار را در KPI یا درآمد اصلی (بسته به آنچه به use_kpi ارسال می‌شود) برمی‌گرداند، همانطور که به InputData ارسال شده است. اگر نادرست باشد، نتیجه را پس از تبدیل توسط KpiTransformer برمی‌گرداند و نحوه نمایش آن را در مدل نشان می‌دهد.
use_kpi بولی. اگر use_kpi = True ، KPI مورد انتظار محاسبه می شود. در غیر این صورت درآمد مورد انتظار (kpi * revenue_per_kpi) محاسبه می شود. لازم است که use_kpi = True اگر revenue_per_kpi تعریف نشده باشد یا اگر inverse_transform_outcome = False باشد.
batch_size عدد صحیح نشان دهنده حداکثر کشش در هر زنجیره در هر دسته است. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
تانسور نتیجه مورد انتظار (یا KPI یا درآمد، بسته به آرگومان use_kpi ) با ابعاد (n_chains, n_draws, n_geos, n_times) . اگر aggregate_geos=True یا aggregate_time=True به ترتیب، ابعاد n_geos و n_times حذف می‌شود.

افزایش می دهد
NotFittedModelError اگر sample_posterior() (برای use_posterior=True ) یا sample_prior() (برای use_posterior=False ) قبل از فراخوانی این متد فراخوانی نشده باشد.

expected_vs_actual_data

مشاهده منبع

داده ها را برای نتیجه مورد انتظار در مقابل واقعی در طول زمان محاسبه می کند.

ارگ
aggregate_geos بولی. اگر True ، مقدار مورد انتظار، پایه و واقعی در تمام مناطق جمع می‌شود.
aggregate_times بولی. اگر True ، مقدار مورد انتظار، پایه و واقعی در تمام دوره‌های زمانی جمع می‌شوند.
split_by_holdout_id بولی. اگر True و holdout_id وجود داشته باشد، داده‌ها به زیربخش‌های 'Train' ، 'Test' و 'All Data' تقسیم می‌شوند.
confidence_level سطح اطمینان برای فواصل معتبر نتیجه مورد انتظار، که به صورت مقداری بین صفر و یک نمایش داده می شود. پیش فرض: 0.9

برمی گرداند
مجموعه داده ای با معیارهای مورد انتظار، خط پایه و نتیجه واقعی.

filter_and_aggregate_geos_and_times

مشاهده منبع

ابعاد جغرافیایی و زمانی یک تانسور را فیلتر و/یا جمع می کند.

ارگ
tensor تانسور با ابعاد [..., n_geos, n_times] یا [..., n_geos, n_times, n_channels] .
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، تمام جغرافیایی گنجانده شده است. مکان‌های جغرافیایی انتخاب شده باید با موارد موجود در InputData.geo مطابقت داشته باشند.
selected_times لیست اختیاری از زمان برای گنجاندن. این می تواند یک لیست رشته ای حاوی زیرمجموعه ای از مختصات بعد زمانی از InputData.time یا یک لیست بولی با طول برابر با بعد زمانی تانسور باشد. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
aggregate_geos بولی. اگر True ، تانسور در تمام زمین‌ها جمع می‌شود.
aggregate_times بولی. اگر True ، تانسور در تمام دوره های زمانی جمع می شود.
flexible_time_dim بولی. اگر True ، بعد زمانی تانسور برای مطابقت با تعداد دوره های زمانی در InputData.time لازم نیست. در این حالت، در صورت استفاده از selected_times ، باید یک لیست بولی با طول برابر با بعد زمانی تانسور باشد.
has_media_dim بولی. فقط در صورت flexible_time_dim=True استفاده می شود. در غیر این صورت، این بر اساس ابعاد تانسور فرض می شود. اگر True ، فرض می شود که تانسور بعد از بعد زمانی دارای بعد رسانه ای است. اگر False ، آخرین بعد تانسور بعد زمانی در نظر گرفته می شود.

برمی گرداند
یک تانسور با ابعاد جغرافیایی و زمانی فیلتر شده و/یا تجمیع شده.

get_aggregated_impressions

مشاهده منبع

مقادیر برداشت‌های جمع‌آوری شده در داده‌ها را در همه کانال‌ها محاسبه می‌کند.

ارگ
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری حاوی زیرمجموعه ای از زمان ها. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
aggregate_geos بولی. اگر True ، نتیجه مورد انتظار در تمام مناطق جمع می شود.
aggregate_times بولی. اگر True ، نتیجه مورد انتظار در تمام دوره های زمانی جمع می شود.
optimal_frequency یک لیست اختیاری با ابعاد n_rf_channels ، حاوی فرکانس بهینه در هر کانال، که میانگین Roi پسین را به حداکثر می‌رساند. مقدار پیش‌فرض None است و فرکانس تاریخی برای محاسبه معیارها استفاده می‌شود.

برمی گرداند
یک تانسور با شکل (n_selected_geos, n_selected_times, n_channels) (یا (n_channels,) در صورت تجمیع مکان‌ها و زمان‌ها) با مقادیر نمایش کلی در هر کانال.

get_r_hat

مشاهده منبع

مقادیر R-hat را برای هر پارامتر در مدل محاسبه می کند.

برمی گرداند
فرهنگ لغت مقادیر r-hat که در آن هر پارامتر یک کلید و مقادیر r-hat مربوط به پارامتر هستند.

افزایش می دهد
NotFittedModelError اگر قبل از فراخوانی این متد ()self.sample_posterior فراخوانی نشود.

hill_curves

مشاهده منبع

جداول منحنی هیل را که برای رسم منحنی های هر کانال استفاده می شود، تخمین می زند.

ارگ
confidence_level سطح اطمینان برای فواصل معتبر قبلی و پسین، به عنوان مقداری بین صفر و یک نمایش داده می شود. پیش فرض 0.9 است.
n_bins تعداد سطل‌هایی با عرض مساوی که باید در هیستوگرام برای ترسیم گنجانده شوند. پیش فرض 25 است.

برمی گرداند
Hill Curves pd.DataFrame با ستون ها:

  • channel : نام کانال media یا rf .
  • media_units : واحدهای رسانه (برای کانال های media ) یا فرکانس متوسط ​​(برای کانال های rf ).
  • distribution : نشان دهنده قرعه کشی posterior یا prior .
  • ci_hi : کران بالای بازه معتبر مقدار تابع Hill.
  • ci_lo : کران پایین بازه معتبر مقدار تابع Hill.
  • mean : میانگین نقطه ای مقدار تابع Hill در هر قرعه کشی.
  • channel_type : نشان دهنده یک کانال media یا rf .
  • scaled_count_histogram : تعداد مقیاس‌شده واحدهای رسانه یا فرکانس‌های متوسط ​​درون سطل.
  • count_histogram : مقدار واقعی شمارش واحدهای رسانه یا فرکانس‌های متوسط ​​درون bin.
  • start_interval_histogram : واحد رسانه یا نقطه شروع فرکانس متوسط ​​برای یک سطل هیستوگرام.
  • end_interval_histogram : واحد رسانه یا نقطه پایان فرکانس متوسط ​​برای سطل هیستوگرام.

incremental_impact

مشاهده منبع

تاثیر افزایشی خلفی یا قبلی را محاسبه می کند.

این تأثیر رسانه ای هر کانال رسانه ای را برای هر ترسیم پارامترهای قبلی یا قبلی محاسبه می کند. تاثیر افزایشی به صورت زیر تعریف می شود:

E(Outcome|Media_1, Controls) منهای E(Outcome|Media_0, Controls)

در اینجا Media_1 به این معنی است که اجرای رسانه برای یک کانال معین در scaling_factor1 (به طور پیش‌فرض 1.0) برای مجموعه دوره‌های زمانی مشخص شده توسط media_selected_times ضرب می‌شود. به طور مشابه، Media_0 به این معنی است که اجرای رسانه در scaling_factor0 (به طور پیش‌فرض 0.0) برای این دوره‌های زمانی ضرب می‌شود.

برای کانال‌هایی با داده‌های دسترسی و فرکانس، فرکانس ثابت می‌ماند در حالی که دسترسی مقیاس‌بندی می‌شود. "نتیجه" یا به revenue اشاره دارد اگر use_kpi=False ، یا kpi اگر use_kpi=True . هنگامی که revenue_per_kpi تعریف نشده است، use_kpi نمی تواند False باشد.

به‌طور پیش‌فرض، «Media» مقادیر رسانه‌ای را نشان می‌دهد که شی Meridian با آن مقداردهی اولیه شده است، اما این می‌تواند توسط آرگومان‌های new_media ، new_reach و new_frequency لغو شود.

محاسبه در این روش به دو فرض کلیدی در اجرای مریدین بستگی دارد:

  1. افزایش افکت های رسانه ای (بدون تعامل).
  2. تغییرات افزایشی در مقیاس KPI مدل با تغییرات افزایشی در مقیاس KPI اصلی مطابقت دارد. به عبارت دیگر، اثرات رهگیری و کنترل تأثیری بر اثرات رسانه ای ندارند. این فرض در حال حاضر صادق است زیرا تبدیل ضربه فقط شامل مرکزیت و مقیاس بندی است، به عنوان مثال، هیچ تبدیل log.

ارگ
use_posterior بولی. اگر True ، توزیع پسین ضربه افزایشی محاسبه می شود. در غیر این صورت، توزیع قبلی محاسبه می شود.
new_media تانسور اختیاری با ابعاد جغرافیایی و کانال مطابق با InputData.media . بعد زمان لازم نیست با ابعاد زمانی InputData.media مطابقت داشته باشد، زیرا می توان رسانه را فراتر از InputData.time ارائه شده در نظر گرفت. اگر داده‌های new_XXX دیگری با تعداد دوره‌های زمانی متفاوت از InputData ارائه شده باشد، الزامی است.
new_reach تانسور اختیاری با ابعاد جغرافیایی و کانال مطابق با InputData.reach . بعد زمان لازم نیست با ابعاد زمانی InputData.reach مطابقت داشته باشد، زیرا می توان دسترسی را فراتر از InputData.time ارائه شده در نظر گرفت. اگر داده‌های new_XXX دیگری با تعداد دوره‌های زمانی متفاوت از InputData ارائه شده باشد، الزامی است.
new_frequency تانسور اختیاری با ابعاد جغرافیایی و کانال مطابق با InputData.frequency . بعد زمان لازم نیست با ابعاد زمانی InputData.frequency مطابقت داشته باشد، زیرا می توان فرکانس را فراتر از InputData.time ارائه شده در نظر گرفت. اگر داده‌های new_XXX دیگری با تعداد دوره‌های زمانی متفاوت از InputData ارائه شده باشد، الزامی است.
new_revenue_per_kpi تانسور اختیاری با بعد جغرافیایی منطبق بر درآمد_در هر کیلو بر اینچ. اگر داده‌های new_XXX دیگری با تعداد دوره‌های زمانی متفاوت از InputData ارائه شده باشد، الزامی است.
scaling_factor0 شناور. عاملی که براساس آن سناریوی خلاف واقع "Media_0" در طول دوره های زمانی مشخص شده در media_selected_times مقیاس بندی می شود. باید غیر منفی و کمتر از scaling_factor1 باشد.
scaling_factor1 شناور. عاملی که بر اساس آن "Media_1" در طول دوره های زمانی انتخاب شده مشخص شده در media_selected_times مقیاس بندی می شود. باید غیر منفی و بزرگتر از scaling_factor0 باشد.
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری شامل زیرمجموعه‌ای از تاریخ‌ها برای گنجاندن یا بولی با طولی برابر با تعداد دوره‌های زمانی در args new_XXX ، در صورت ارائه. تاثیر افزایشی مربوط به KPI افزایشی است که در طول آرگ selected_times توسط رسانه اجرا شده در طول media_selected_times arg تولید می‌شود. توجه داشته باشید که اگر use_kpi=False ، سپس selected_times فقط می‌تواند شامل دوره‌های زمانی باشد که داده‌های ورودی revenue_per_kpi دارند. به‌طور پیش‌فرض، همه دوره‌های زمانی درج شده است که داده‌های revenue_per_kpi در دسترس است.
media_selected_times فهرست اختیاری شامل زیرمجموعه‌ای از تاریخ‌ها برای گنجاندن یا بولی با طولی برابر با تعداد دوره‌های زمانی در new_media ، در صورت ارائه. اگر new_media ارائه شده باشد، media_selected_times می تواند هر زیر مجموعه ای از دوره های زمانی را در new_media انتخاب کند. اگر new_media ارائه نشده باشد، media_selected_times از InputData.time انتخاب می‌کند. تاثیر افزایشی مربوط به KPI افزایشی است که در طول آرگ selected_times توسط رسانه اجرا شده در طول media_selected_times arg تولید می‌شود. برای هر کانال، تأثیر افزایشی به عنوان تفاوت بین KPI مورد انتظار تعریف می‌شود، زمانی که اجرای رسانه توسط scaling_factor1 و scaling_factor0 در طول این دوره‌های زمانی مشخص شده مقیاس‌بندی می‌شود. به‌طور پیش‌فرض، تفاوت بین رسانه در سطوح اجرای تاریخی، یا همانطور که در new_media ارائه شده است، در مقابل اجرای صفر است. پیش‌فرض شامل تمام دوره‌های زمانی است.
aggregate_geos بولی. اگر True ، تأثیر افزایشی در تمام مناطق خلاصه می شود.
aggregate_times بولی. اگر True ، تأثیر افزایشی در تمام دوره‌های زمانی جمع می‌شود.
inverse_transform_impact بولی. اگر True ، تأثیر مورد انتظار را در KPI یا درآمد اصلی (بسته به آنچه که به use_kpi ارسال می‌شود) برمی‌گرداند، همانطور که به InputData ارسال شده است. اگر نادرست باشد، تأثیر را پس از تبدیل توسط KpiTransformer برمی‌گرداند، و نحوه نمایش آن را در مدل نشان می‌دهد.
use_kpi بولی. اگر use_kpi = True ، KPI مورد انتظار محاسبه می شود. در غیر این صورت درآمد مورد انتظار (kpi * revenue_per_kpi) محاسبه می شود. لازم است که use_kpi = True اگر داده‌های revenue_per_kpi در دسترس نیست یا اگر inverse_transform_impact = False .
batch_size عدد صحیح نشان دهنده حداکثر کشش در هر زنجیره در هر دسته است. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
تانسور تأثیر افزایشی (اعم از KPI یا درآمد، بسته به آرگومان use_kpi ) با ابعاد (n_chains, n_draws, n_geos, n_times, n_channels) که در آن n_channels تعداد کل رسانه ها و کانال های RF است. اگر aggregate_geos=True یا aggregate_times=True باشد، ابعاد n_geos و n_times حذف می شوند.

افزایش می دهد
NotFittedModelError اگر sample_posterior() (برای use_posterior=True ) یا sample_prior() (برای use_posterior=False ) قبل از فراخوانی این متد فراخوانی نشده باشد.
ValueError اگر آرگومان های new_media شکل تانسور مشابه رسانه را نداشته باشند.

marginal_roi

مشاهده منبع

ROI حاشیه ای توزیع قبلی یا پسین را محاسبه می کند.

شمارش‌کننده ROI حاشیه‌ای (mROI) تغییر در نتیجه مورد انتظار ( kpi یا kpi * revenue_per_kpi ) است که هزینه‌های یک کانال به کسری کوچک افزایش می‌یابد. مخرج mROI کسر کوچک مربوط به کل هزینه کانال است. وقتی revenue_per_kpi در دسترس نیست، change_in_outcome / spend معادل change_in_revenue / spend با این فرض که revenue_per_kpi=1 است.

ارگ
incremental_increase کسری کوچک که هزینه هر کانال هنگام محاسبه شمارشگر mROI آن افزایش می یابد. مخرج mROI این کسری از کل هزینه کانال است. فقط در صورتی استفاده می شود که حاشیه True باشد.
use_posterior اگر True ، توزیع پسین محاسبه می شود. در غیر این صورت، توزیع قبلی محاسبه می شود.
new_media اختیاری. داده‌های رسانه با شکل مشابه meridian.input_data.media . برای محاسبه mROI برای داده های رسانه جایگزین استفاده می شود. پیش فرض از meridian.input_data.media استفاده می کند.
new_media_spend اختیاری. رسانه ها داده هایی را با شکل مشابه meridian.input_data.spend مصرف می کنند. برای محاسبه mROI برای داده های media_spend جایگزین استفاده می شود. پیش‌فرض از meridian.input_data.media_spend استفاده می‌کند.
new_reach اختیاری. به داده هایی با شکل مشابه meridian.input_data.reach دسترسی پیدا کنید. برای محاسبه mROI برای داده های دسترسی جایگزین استفاده می شود. پیش فرض از meridian.input_data.reach استفاده می کند.
new_frequency اختیاری. داده‌های فرکانس با شکل مشابه meridian.input_data.frequency . برای محاسبه mROI برای داده های فرکانس جایگزین استفاده می شود. پیش‌فرض از meridian.input_data.frequency استفاده می‌کند.
new_rf_spend اختیاری. RF داده ها را با همان شکل meridian.input_data.rf_spend خرج کنید. برای محاسبه mROI برای داده های جایگزین rf_spend استفاده می شود. پیش فرض از meridian.input_data.rf_spend استفاده می کند.
selected_geos اختیاری. شامل زیرمجموعه‌ای از geos برای گنجاندن است. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times اختیاری. شامل زیرمجموعه ای از زمان ها برای درج است. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
aggregate_geos اگر True ، درآمد مورد انتظار در تمام مناطق جمع می شود.
aggregate_times اگر True ، درآمد مورد انتظار در تمام دوره های زمانی جمع می شود.
by_reach برای یک کانال با دسترسی و فرکانس استفاده می شود. اگر True ، mROI را با رسیدن به یک فرکانس ثابت معین برمی‌گرداند. اگر False ، mROI را بر اساس فرکانس برای یک دسترسی ثابت معین برمی گرداند.
use_kpi اگر True ، از درآمد برای محاسبه شمارشگر mROI استفاده می شود. در غیر این صورت، از KPI برای محاسبه شمارشگر mROI استفاده می کند.
batch_size حداکثر کشش در هر زنجیره در هر دسته. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
تانسور مقادیر mROI با ابعاد (n_chains, n_draws, n_geos, n_times, (n_media_channels + n_rf_channels)) . اگر aggregate_geos=True یا aggregate_times=True باشد، ابعاد n_geos و n_times حذف می شوند.

media_summary_metrics

مشاهده منبع

معیارهای خلاصه رسانه را برمی‌گرداند.

توجه داشته باشید که معیارهای mroi و effectiveness ( math.nan ) برای بعد مجموع کانال "All Channels" تعریف نشده اند.

ارگ
marginal_roi_by_reach بولی. ROI حاشیه ای (mROI) به عنوان بازده دلار خرج شده بعدی تعریف می شود. اگر این استدلال True باشد، فرض بر این است که دلار بعدی که خرج می‌شود تنها بر روی رسیدن تأثیر می‌گذارد و فرکانس را ثابت نگه می‌دارد. اگر این استدلال False باشد، فرض بر این است که دلار بعدی صرف شده تنها بر فرکانس تأثیر می گذارد و رسیدن به آن ثابت نگه داشته می شود.
marginal_roi_incremental_increase کسری کوچک که هزینه هر کانال هنگام محاسبه شمارشگر mROI آن افزایش می یابد. مخرج mROI این کسری از کل هزینه کانال است.
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری حاوی زیرمجموعه ای از زمان ها. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
aggregate_geos بولی. اگر True ، نتیجه مورد انتظار در تمام مناطق جمع می شود.
aggregate_times بولی. اگر True ، نتیجه مورد انتظار در تمام دوره های زمانی جمع می شود.
optimal_frequency یک لیست اختیاری با ابعاد n_rf_channels ، حاوی فرکانس بهینه در هر کانال، که میانگین Roi پسین را به حداکثر می‌رساند. مقدار پیش‌فرض None است و فرکانس تاریخی برای محاسبه معیارها استفاده می‌شود.
use_kpi بولی. اگر True ، معیارهای خلاصه رسانه با استفاده از KPI محاسبه می‌شوند. اگر False ، معیارها با استفاده از درآمد محاسبه می‌شوند.
confidence_level سطح اطمینان برای فواصل معتبر معیارهای خلاصه رسانه، که به صورت مقداری بین صفر و یک نمایش داده می‌شود.
batch_size عدد صحیح نشان دهنده حداکثر کشش در هر زنجیره در هر دسته است. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
یک xr.Dataset با مختصات: channel ، metric ( mean ، median ، ci_low ، ci_highdistribution (قبلی، پسین) و حاوی متغیرهای داده زیر است: impressions ، pct_of_impressions ، spend ، pct_of_spend ، CPM ، incremental_impact ، roi effectiveness pct_of_contribution , mroi , cpik .

optimal_freq

مشاهده منبع

فرکانس بهینه را محاسبه می کند که میانگین ROI خلفی را به حداکثر می رساند.

برای این بهینه‌سازی، هزینه‌های تاریخی استفاده می‌شود و ثابت می‌شود، و فرکانس برای ثابت بودن در تمام مناطق جغرافیایی و دوره‌های زمانی محدود می‌شود. دسترسی برای هر منطقه جغرافیایی و دوره زمانی محاسبه می‌شود، به طوری که با تغییر فراوانی، تعداد نمایش‌ها بدون تغییر باقی می‌ماند. مریدین فرکانس هایی را که در آن ROI متوسط ​​خلفی بهینه می شود، حل می کند.

ارگ
freq_grid فهرست مقادیر فرکانس ROI هر کانال برای هر مقدار فرکانس در لیست محاسبه می شود. به طور پیش فرض، لیست شامل اعداد از 1.0 تا حداکثر فرکانس با افزایش 0.1 است.
use_posterior بولی. اگر True ، فرکانس‌های بهینه پسین تولید می‌شوند. اگر False ، فرکانس‌های بهینه قبلی تولید می‌شوند.
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری حاوی زیرمجموعه ای از زمان ها. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
confidence_level سطح اطمینان برای فواصل معتبر قبلی و پسین، به عنوان مقداری بین صفر و یک نمایش داده می شود.

برمی گرداند
یک مجموعه داده xarray که شامل: * مختصات: frequency ، rf_channel ، metric ( mean ، median ، ci_lo ، ci_hi ). * متغیرهای داده: * optimal_frequency : بسامدی که میانگین پسینی ROI را بهینه می‌کند. * roi : ROI برای هر مقدار فرکانس در freq_grid . * optimized_incremental_impact : تاثیر افزایشی بر اساس فرکانس بهینه. * optimized_pct_of_contribution : درصد مشارکت بر اساس فرکانس بهینه. * optimized_effectiveness : اثربخشی بر اساس فرکانس بهینه. * optimized_roi : ROI بر اساس فرکانس بهینه. * optimized_mroi_by_reach : ROI حاشیه ای با تغییر کمی در دسترسی و فرکانس ثابت در فرکانس بهینه. * optimized_mroi_by_frequency : ROI حاشیه ای با یک تغییر کوچک در فرکانس بهینه و دسترسی ثابت. * optimized_cpik : CPIK بر اساس فرکانس بهینه.

افزایش می دهد
NotFittedModelError اگر sample_posterior() (برای use_posterior=True ) یا sample_prior() (برای use_posterior=False ) قبل از فراخوانی این متد فراخوانی نشده باشد.
ValueError اگر کانالی با داده های دسترسی و فرکانس وجود ندارد.

predictive_accuracy

مشاهده منبع

معیارهای برازش R-Squared ، MAPE و wMAPE را محاسبه می کند.

R-Squared ، MAPE (میانگین درصد خطای مطلق)، و wMAPE (خطای درصد مطلق وزنی) در مقیاس درآمد ( KPI * revenue_per_kpi ) زمانی که revenue_per_kpi مشخص شده است، یا مقیاس KPI زمانی که revenue_per_kpi = None محاسبه می شود. این همان مقیاسی است که در شمارشگر ROI (درآمد افزایشی) استفاده می شود.

خطاهای پیش‌بینی در wMAPE با درآمد واقعی وزن‌گذاری می‌شوند ( KPI * revenue_per_kpi ) زمانی که revenue_per_kpi مشخص می‌شود، یا با مقیاس KPI وزن می‌شوند زمانی که revenue_per_kpi = None . این بدان معناست که درصد خطاهای زمانی که درآمد زیاد است وزن بیشتری نسبت به خطاهای زمانی که درآمد کم است، دارد.

R-Squared ، MAPE و wMAPE هم در سطح مدل (یک مشاهده در هر دوره جغرافیایی و زمانی) و هم در سطح ملی (تجمیع KPI یا نتیجه درآمد در مناطق جغرافیایی بنابراین یک مشاهده در هر دوره زمانی) محاسبه می‌شوند.

R-Squared ، MAPE و wMAPE برای نمونه کامل محاسبه می شود. اگر شی مدل دارای مشاهدات نگهدارنده باشد، آنگاه R-squared ، MAPE و wMAPE نیز برای زیر مجموعه‌های Train و Test محاسبه می‌شوند.

ارگ
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری حاوی زیرمجموعه‌ای از تاریخ‌ها برای گنجاندن. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
batch_size عدد صحیح نشان دهنده حداکثر کشش در هر زنجیره در هر دسته است. به طور پیش فرض، batch_size 100 است. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
یک مجموعه داده xarray حاوی مقادیر محاسبه‌شده R_Squared ، MAPE ، و wMAPE ، با مختصات metric ، geo_granularity ، evaluation_set ، و value متغیر داده همراه. اگر holdout_id وجود داشته باشد، داده‌ها به زیربخش‌های 'Train' ، 'Test' و 'All Data' تقسیم می‌شوند و سه معیار برای هر کدام محاسبه می‌شود.

r_hat_summary

مشاهده منبع

خلاصه ای از مقادیر R-hat را برای هر پارامتر در مدل محاسبه می کند.

کاهش مقیاس بالقوه Gelman & Rubin (1992) را برای همگرایی زنجیره ای محاسبه می کند که معمولاً به عنوان R-hat نامیده می شود. این یک معیار تشخیصی همگرایی است که درجه ای را اندازه می گیرد که واریانس (میانگین) بین زنجیره ها از آنچه انتظار دارید اگر زنجیره ها به طور یکسان توزیع شوند را اندازه می گیرد. مقادیر نزدیک به 1.0 نشان دهنده همگرایی است. R-hat < 1.2 نشان دهنده همگرایی تقریبی است و یک آستانه معقول برای بسیاری از مشکلات است (Brooks & Gelman, 1998).

مراجع
اندرو گلمن و دونالد بی روبین. استنتاج از شبیه سازی تکراری با استفاده از توالی های متعدد. علوم آماری، 7 (4): 457-472، 1992. Stephen P. Brooks and Andrew Gelman. روش های عمومی برای نظارت بر همگرایی شبیه سازی های تکراری. مجله آمار محاسباتی و گرافیکی، 7(4)، 1377.

ارگ
bad_r_hat_threshold آستانه تعیین اینکه کدام مقادیر R-hat بد در نظر گرفته می شوند.

برمی گرداند
یک DataFrame با ستون های زیر:

  • n_params : تعداد پارامترهای مربوطه در مدل.
  • avg_rhat : میانگین مقدار R-hat برای پارامتر مربوطه.
  • n_params : تعداد پارامترهای مربوطه در مدل.
  • avg_rhat : میانگین مقدار R-hat برای پارامتر مربوطه.
  • max_rhat : حداکثر مقدار R-hat برای پارامتر مربوطه.
  • percent_bad_rhat bad_r_hat_threshold
  • row_idx_bad_rhat : شاخص های ردیف مقادیر R-hat که بزرگتر از bad_r_hat_threshold هستند.
  • col_idx_bad_rhat : شاخص های ستون مقادیر R-hat که بزرگتر از bad_r_hat_threshold هستند.

افزایش می دهد
NotFittedModelError اگر قبل از فراخوانی این متد self.sample_posterior() فراخوانی نشود.
ValueError اگر تعداد ابعاد آرایه R-hat برای یک پارامتر 1 یا 2 نباشد.

response_curves

مشاهده منبع

روش تولید منحنی پاسخ xarray.Dataset.

منحنی‌های پاسخ در سطح ملی با فرض الگوی پرواز تاریخی در طول جغرافیایی و دوره‌های زمانی برای هر کانال رسانه محاسبه می‌شوند. فهرستی از ضریب‌ها برای کل هزینه‌های تاریخی هر کانال رسانه اعمال می‌شود تا x-values که در آن منحنی پاسخ کانال محاسبه می‌شود، به دست آید.

ارگ
spend_multipliers لیست ضرب کننده ها کل هزینه هر کانال در این عوامل ضرب می شود تا مقادیری که منحنی برای آن کانال محاسبه می شود به دست آید.
use_posterior بولی. اگر True ، منحنی‌های پاسخ خلفی ایجاد می‌شوند. اگر False ، منحنی های پاسخ قبلی ایجاد می شوند.
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری شامل زیرمجموعه‌ای از ابعاد زمانی برای گنجاندن. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است. رشته ها و اعداد صحیح بعد زمانی باید با Meridian.n_times هماهنگ شوند.
by_reach بولی. برای کانال های با دسترسی و فرکانس. اگر True ، منحنی پاسخ را بر اساس دسترسی رسم می کند. اگر False ، منحنی پاسخ را بر اساس فرکانس رسم می کند.
use_optimal_frequency اگر True ، از فرکانس بهینه برای رسم منحنی های پاسخ استفاده می کند. پیش فرض ها به False .
confidence_level سطح اطمینان برای فواصل معتبر قبلی و پسین، به عنوان مقداری بین صفر و یک نمایش داده می شود.
batch_size عدد صحیح نشان دهنده حداکثر کشش در هر زنجیره در هر دسته است. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
یک xarray.Dataset حاوی داده های مورد نیاز برای تجسم منحنی های پاسخ.

roi

مشاهده منبع

توزیع ROI قبلی یا پسین را برای هر کانال رسانه محاسبه می کند.

شمارشگر ROI تغییر در نتیجه مورد انتظار است ( kpi یا kpi * revenue_per_kpi ) زمانی که هزینه یک کانال روی صفر تنظیم می شود و هزینه تمام کانال های دیگر بدون تغییر باقی می ماند. مخرج ROI کل هزینه کانال است. وقتی revenue_per_kpi در دسترس نیست، change_in_outcome / spend معادل change_in_revenue / spend با این فرض که revenue_per_kpi=1 است.

ارگ
use_posterior بولی. اگر True ، توزیع پسین محاسبه می شود. در غیر این صورت، توزیع قبلی محاسبه می شود.
new_media اختیاری. داده‌های رسانه با شکل مشابه meridian.input_data.media . برای محاسبه ROI برای داده های رسانه جایگزین استفاده می شود. پیش فرض از meridian.input_data.media استفاده می کند.
new_media_spend اختیاری. رسانه ها داده هایی را با شکل مشابه meridian.input_data.spend مصرف می کنند. برای محاسبه ROI برای داده های media_spend جایگزین استفاده می شود. پیش‌فرض از meridian.input_data.media_spend استفاده می‌کند.
new_reach اختیاری. به داده هایی با شکل مشابه meridian.input_data.reach دسترسی پیدا کنید. برای محاسبه ROI برای داده های دسترسی جایگزین استفاده می شود. پیش فرض از meridian.input_data.reach استفاده می کند.
new_frequency اختیاری. داده‌های فرکانس با شکل مشابه meridian.input_data.frequency . برای محاسبه ROI برای داده های فرکانس جایگزین استفاده می شود. پیش‌فرض از meridian.input_data.frequency استفاده می‌کند.
new_rf_spend اختیاری. RF داده ها را با همان شکل meridian.input_data.rf_spend خرج کنید. برای محاسبه ROI برای داده های جایگزین rf_spend استفاده می شود. پیش فرض از meridian.input_data.rf_spend استفاده می کند.
selected_geos لیست اختیاری حاوی زیرمجموعه ای از موقعیت های جغرافیایی برای گنجاندن. به طور پیش فرض، تمام جغرافیایی گنجانده شده است.
selected_times فهرست اختیاری حاوی زیرمجموعه ای از زمان ها. به طور پیش فرض، تمام دوره های زمانی گنجانده شده است.
aggregate_geos بولی. اگر True ، درآمد مورد انتظار در تمام مناطق جمع می شود.
aggregate_times بولی. اگر True ، درآمد مورد انتظار در تمام دوره های زمانی جمع می شود.
use_kpi اگر True ، از درآمد برای محاسبه شمارش ROI استفاده می شود. در غیر این صورت، از KPI برای محاسبه شمارش ROI استفاده می کند.
batch_size عدد صحیح نشان دهنده حداکثر کشش در هر زنجیره در هر دسته است. محاسبه به صورت دسته‌ای انجام می‌شود تا از فرسودگی حافظه جلوگیری شود. اگر خطای حافظه رخ داد، سعی کنید batch_size کاهش دهید. محاسبه معمولاً با مقادیر batch_size بزرگتر سریعتر خواهد بود.

برمی گرداند
تانسور مقادیر ROI با ابعاد (n_chains, n_draws, n_geos, n_times, (n_media_channels + n_rf_channels)) . اگر aggregate_geos=True یا aggregate_times=True باشد، ابعاد n_geos و n_times حذف می شوند.