meridian.data.input_data.InputData

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

meridian.data.input_data.InputData(
    kpi: xr.DataArray,
    kpi_type: str,
    controls: xr.DataArray,
    population: xr.DataArray,
    revenue_per_kpi: (xr.DataArray | None) = None,
    media: (xr.DataArray | None) = None,
    media_spend: (xr.DataArray | None) = None,
    reach: (xr.DataArray | None) = None,
    frequency: (xr.DataArray | None) = None,
    rf_spend: (xr.DataArray | None) = None
)

صفات
kpi	یک آرایه داده از ابعاد (n_geos, n_times) حاوی متغیر وابسته غیر منفی. معمولاً این تعداد واحدهای فروخته شده است، اما می تواند هر معیاری باشد، مانند درآمد یا تبدیل.
kpi_type	رشته ای که نشان می دهد KPI از نوع 'revenue' یا 'non-revenue' است. زمانی که kpi_type 'non-revenue' است و revenue_per_kpi وجود دارد، کالیبراسیون ROI استفاده می شود و تجزیه و تحلیل بر اساس درآمد اجرا می شود. وقتی revenue_per_kpi برای همان kpi_type وجود ندارد، کالیبراسیون ROI سفارشی استفاده می‌شود و تجزیه و تحلیل بر روی KPI اجرا می‌شود.
controls	یک آرایه داده از ابعاد (n_geos, n_times, n_controls) حاوی مقادیر متغیر کنترل.
population	یک آرایه داده از ابعاد (n_geos,) که شامل جمعیت هر گروه است. این متغیر برای مقیاس بندی KPI و رسانه برای مدل سازی استفاده می شود.
revenue_per_kpi	یک آرایه داده اختیاری از ابعاد (n_geos, n_times) که حاوی میانگین درآمد در هر واحد KPI است. اگرچه مدل‌سازی بر روی kpi انجام می‌شود، تحلیل و بهینه‌سازی مدل بر روی KPI * revenue_per_kpi (درآمد) انجام می‌شود، اگر این مقدار موجود باشد. اگر kpi با درآمد مطابقت داشته باشد، آرایه ای از یک ها به طور خودکار ارسال می شود.
media	آرایه داده اختیاری از ابعاد (n_geos, n_media_times, n_media_channels) حاوی مقادیر غیرمنفی اجرای رسانه. اینها معمولاً برداشت‌ها هستند، اما می‌تواند هر معیاری مانند هزینه یا کلیک‌ها باشد. n_media_times ≥ n_times مورد نیاز است، و دوره های زمانی n_times نهایی باید با پنجره زمانی kpi و controls هماهنگ باشند. به دلیل تأخیر اثرات، توصیه می‌کنیم که پنجره زمانی رسانه‌ها حداکثر تا max_lag دوره‌های اضافی قبل از این پنجره را شامل شود. اگر n_media_times < n_times + max_lag باشد، مدل به طور موثر سابقه رسانه را نسبت می دهد. اگر n_media_times > n_times + max_lag , آنگاه فقط دوره های n_times + max_lag نهایی برای برازش مدل استفاده می شود. media و media_spend باید دارای تعداد یکسانی از کانال‌های رسانه به ترتیب یکسان باشند. اگر هر یک از این آرگومان ها تصویب شود، دیگری اختیاری نیست.
media_spend	یک DataArray اختیاری که شامل هزینه هر کانال رسانه است. این به عنوان مخرج برای محاسبات ROI استفاده می شود. شکل DataArray می تواند (n_geos, n_times, n_media_channels) یا (n_media_channels,) باشد اگر داده ها در ابعاد geo و time جمع شوند. کل هزینه را با پنجره زمانی kpi تنظیم کنید و داده ها را controls ، که پنجره زمانی است که درآمد افزایشی شمارشگر ROI در آن محاسبه می شود. درآمد افزایشی تحت تأثیر اجرای رسانه قبل از این پنجره زمانی، از طریق تأثیرات تأخیر است. media و media_spend باید دارای تعداد یکسانی از کانال‌های رسانه به ترتیب یکسان باشند. اگر هر یک از این آرگومان ها تصویب شود، دیگری اختیاری نیست.
reach	DataArray اختیاری از ابعاد (n_geos, n_media_times, n_rf_channels) حاوی مقادیر reach غیرمنفی. لازم است که n_media_times ≥ n_times ، و n_times پایانی دوره های زمانی باید با پنجره زمانی kpi و controls هماهنگ باشند. پنجره زمانی باید شامل پنجره زمانی kpi و داده‌های controls باشد، اما این اختیاری است که دوره‌های زمانی عقب افتاده قبل از پنجره زمانی kpi و داده‌های controls را شامل شود. اگر دسترسی تأخیر گنجانده نشده باشد، یا اگر دستیابی تأخیر کمتر از دوره‌های زمانی max_lag باشد، مدل Adstock را با این فرض محاسبه می‌کند که اجرای دستیابی قبل از اولین دوره زمانی مشاهده‌شده صفر است. توصیه می‌کنیم دوره‌های زمانی n_times + max_lag را نیز درج کنید، مگر اینکه مقدار max_lag به‌طور غیرقابل قبولی بزرگ باشد. اگر فقط از داده های media استفاده شود، reach None خواهد بود. reach ، frequency و rf_spend باید دارای تعداد یکسانی از کانال های رسانه به ترتیب یکسان باشد. اگر هر یک از این آرگومان ها تصویب شود، بقیه اختیاری نیستند.
frequency	DataArray اختیاری از ابعاد (n_geos, n_media_times, n_rf_channels) حاوی مقادیر frequency غیرمنفی. لازم است که n_media_times ≥ n_times ، و n_times پایانی دوره های زمانی باید با پنجره زمانی kpi و controls هماهنگ باشند. پنجره زمانی باید شامل پنجره زمانی kpi و داده‌های controls باشد، اما این اختیاری است که دوره‌های زمانی عقب افتاده قبل از پنجره زمانی kpi و داده‌های controls را شامل شود. اگر فرکانس تأخیر گنجانده نشود، یا اگر فرکانس تأخیر کمتر از دوره‌های زمانی max_lag باشد، مدل Adstock را با این فرض محاسبه می‌کند که اجرای فرکانس قبل از اولین دوره زمانی مشاهده‌شده صفر است. توصیه می‌کنیم دوره‌های زمانی n_times + max_lag را نیز درج کنید، مگر اینکه مقدار max_lag به‌طور غیرقابل قبولی بزرگ باشد. اگر فقط از داده های media استفاده شود، frequency None خواهد بود. reach ، frequency و rf_spend باید دارای تعداد یکسانی از کانال های رسانه به ترتیب یکسان باشد. اگر هر یک از این آرگومان ها تصویب شود، بقیه اختیاری نیستند.
rf_spend	یک DataArray اختیاری که شامل هزینه هر کانال دسترسی و فرکانس است. این به عنوان مخرج برای محاسبات ROI استفاده می شود. شکل DataArray می تواند (n_rf_channels,) ، (n_geos, n_times, n_rf_channels) یا (n_geos, n_rf_channels) باشد. هزینه ها باید در ابعاد جغرافیایی و/یا زمانی که نشان داده نشده اند جمع آوری شود. ما توصیه می کنیم که کل هزینه با پنجره زمانی kpi هماهنگ شود و داده ها را controls ، که پنجره زمانی است که تاثیر افزایشی شمارشگر ROI در آن محاسبه می شود. با این حال، توجه داشته باشید که تأثیر افزایشی تحت تأثیر اجرای رسانه قبل از این پنجره زمانی، از طریق جلوه‌های تاخیری قرار می‌گیرد، و اثرات تأخیر فراتر از پنجره زمانی رسانه اجرا شده در طول پنجره زمانی را حذف می‌کند. اگر فقط از داده های media استفاده شود، rf_spend None خواهد بود. reach ، frequency و rf_spend باید دارای تعداد یکسانی از کانال های رسانه به ترتیب یکسان باشد. اگر هر یک از این آرگومان ها تصویب شود، بقیه اختیاری نیستند.
control_variable	بعد متغیر کنترل را برمی‌گرداند.
geo	بعد جغرافیایی را برمی‌گرداند.
media_channel	بعد کانال رسانه را برمی‌گرداند.
media_spend_has_geo_dimension	بررسی می کند که آیا آرایه media_spend بعد جغرافیایی دارد یا خیر.
media_spend_has_time_dimension	بررسی می کند که آیا آرایه media_spend بعد زمانی دارد یا خیر.
media_time	مختصات بعد زمان رسانه را برمی‌گرداند.
media_time_coordinates	بعد زمان رسانه را در بسته بندی TimeCoordinates برمی گرداند.
rf_channel	بعد کانال RF را برمی‌گرداند.
rf_spend_has_geo_dimension	بررسی می کند که آیا آرایه rf_spend بعد جغرافیایی دارد یا خیر.
rf_spend_has_time_dimension	بررسی می کند که آیا آرایه rf_spend بعد زمانی دارد یا خیر.
time	مختصات بعد زمانی را برمی گرداند.
time_coordinates	بعد زمان (KPI) را در بسته بندی TimeCoordinates برمی گرداند.

روش ها

as_dataset

مشاهده منبع

as_dataset() -> xr.Dataset

داده ها را به عنوان یک شی منفرد xarray.Dataset برمی گرداند.

get_all_channels

مشاهده منبع

get_all_channels() -> np.ndarray

همه ابعاد کانال، از جمله رسانه و RF را برمی‌گرداند.

get_all_media_and_rf

مشاهده منبع

get_all_media_and_rf() -> np.ndarray

همه مقادیر اجرای رسانه، از جمله رسانه و RF را برمی‌گرداند.

اگر رسانه، دسترسی و فرکانس برای مدل‌سازی استفاده می‌شد، فرکانس دسترسی * به انتهای رسانه متصل می‌شود.

برمی گرداند
np.ndarray با ابعاد (n_geos, n_media_times, n_channels) حاوی رسانه یا فرکانس رسیدن * برای هر media_channel یا rf_channel .

get_n_top_largest_geos

مشاهده منبع

get_n_top_largest_geos(
    num_geos: int
) -> list[str]

تعداد مشخصی از بزرگترین زمین ها را بر اساس جمعیت پیدا می کند.

ارگ
num_geos	تعداد بزرگترین مکان‌های جغرافیایی برای بازگشت بر اساس جمعیت.

برمی گرداند
فهرستی از تعداد مشخص شده از بزرگترین مکان های جغرافیایی.

get_total_spend

مشاهده منبع

get_total_spend() -> np.ndarray

کل هزینه‌ها، از جمله media_spend و rf_spend را برمی‌گرداند.

__eq__

__eq__(
    other
)

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

متغیرهای کلاس
فرکانس	None
رسانه ها	None
رسانه_خرج کردن	None
رسیدن	None
درآمد_در هر کیلو بر اینچ	None
rf_spend	None