меридиан.данные.input_data.InputData

Контейнер данных для рекламных данных в формате, поддерживаемом Meridian.

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	DataArray размеров (n_geos, n_times) содержащий неотрицательную зависимую переменную. Обычно это количество проданных единиц, но это может быть любой показатель, например доход или конверсии.
kpi_type	Строка, указывающая, относится ли KPI к 'revenue' или 'non-revenue' типу. Если для kpi_type установлено значение 'non-revenue' и revenue_per_kpi , используется калибровка рентабельности инвестиций и анализ выполняется на основе дохода. Если revenue_per_kpi не существует для того же kpi_type , используется пользовательская калибровка рентабельности инвестиций и анализ выполняется на основе ключевого показателя эффективности.
controls	DataArray размерностей (n_geos, n_times, n_controls) содержащий значения управляющих переменных.
population	Массив данных измерений (n_geos,) содержащий население каждой группы. Эта переменная используется для масштабирования KPI и медиа для моделирования.
revenue_per_kpi	Необязательный массив данных с измерениями (n_geos, n_times) содержащий среднюю сумму дохода на единицу ключевого показателя эффективности. Хотя моделирование выполняется на основе kpi , анализ и оптимизация модели выполняются на основе KPI * revenue_per_kpi (доход), если это значение доступно. Если kpi соответствует выручке, то массив единиц передается автоматически.
media	Необязательный массив данных DataArray с измерениями (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 содержащий стоимость каждого медиаканала. Это используется в качестве знаменателя для расчета рентабельности инвестиций. Форма DataArray может иметь вид (n_geos, n_times, n_media_channels) или (n_media_channels,) если данные агрегируются по geo и time измерениям. Выровняйте общую стоимость с временным окном данных kpi и controls , которое представляет собой временное окно, в течение которого рассчитывается дополнительный доход числителя рентабельности инвестиций. На дополнительный доход влияет реализация рекламы до этого временного окна через лагированные эффекты. 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 содержащий стоимость каждого канала охвата и частоты. Это используется в качестве знаменателя для расчета рентабельности инвестиций. Форма DataArray может быть (n_rf_channels,) , (n_geos, n_times, n_rf_channels) или (n_geos, n_rf_channels) . Расходы должны быть агрегированы по географическим и/или временным измерениям, которые не представлены. Мы рекомендуем, чтобы общая сумма расходов соответствовала временному окну данных kpi и controls , то есть временному окну, в течение которого рассчитывается дополнительное влияние числителя рентабельности инвестиций). Однако обратите внимание, что на дополнительное воздействие влияет выполнение мультимедиа до этого временного окна через запаздывающие эффекты и исключает лагированные эффекты за пределами временного окна мультимедиа, выполняемого в течение этого временного окна. Если используются только 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_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
)

Вернуть значение self==.

Переменные класса
частота	None
СМИ	None
media_spend	None
достигать	None
доход_per_kpi	None
rf_spend	None