polars.Series.rolling_quantile_by

Series.rolling_quantile_by(
    by: IntoExpr,
    window_size: timedelta | str_,
    *,
    quantile: float,
    interpolation: QuantileMethod = 'nearest',
    min_samples: int = 1,
    closed: ClosedInterval = 'right',
) → Self

Вычисляет скользящую квантиль на основе другого ряда.

Предупреждение

Эта функциональность считается нестабильной. Она может измениться в любой момент без того, чтобы это считалось нарушением обратной совместимости.

Для столбца by <t_0, t_1, ..., t_n> closed="right" (значение по умолчанию) означает, что окна будут следующими:

• (t_0 - window_size, t_0]
• (t_1 - window_size, t_1]
• …
• (t_n - window_size, t_n]

Параметры:

by

Должен иметь тип данных DateTime, Date, UInt64, UInt32, Int64 или Int32 (обратите внимание, что для целочисленных типов необходимо использовать 'i' в window size).

quantile

Квантиль от 0,0 до 1,0.

interpolation{‘nearest’, ‘higher’, ‘lower’, ‘midpoint’, ‘linear’, ‘equiprobable’}

Метод интерполяции.

window_size

Длина окна. Может быть динамическим временным интервалом, заданным объектом timedelta, или строкой в следующем формате:

• 1ns (1 наносекунда)
• 1us (1 микросекунда)
• 1ms (1 миллисекунда)
• 1s (1 секунда)
• 1m (1 минута)
• 1h (1 час)
• 1d (1 календарный день)
• 1w (1 календарная неделя)
• 1mo (1 календарный месяц)
• 1q (1 календарный квартал)
• 1y (1 календарный год)
• 1i (1 индекс)

Под «календарным днём» подразумевается соответствующее время следующего дня (который может длиться не 24 часа из-за перехода на летнее время; в неоднозначных случаях мы следуем RFC-5545 и сохраняем признак DST fold исходного объекта datetime). Аналогично трактуются «календарная неделя», «календарный месяц», «календарный квартал» и «календарный год».

min_samples

Количество значений в окне, которые должны быть ненулевыми, прежде чем будет вычислен результат.

closed{‘left’, ‘right’, ‘both’, ‘none’}

Задаёт, какие границы временного интервала включаются; значение по умолчанию — 'right'.

Примечания

Если вы хотите вычислить несколько агрегирующих статистик для одного и того же динамического окна, рассмотрите возможность использования rolling — этот метод может кэшировать вычисление размера окна.

Примеры

Создайте ряд со значением индекса строки

>>> from datetime import timedelta, datetime
>>> start = datetime(2001, 1, 1)
>>> stop = datetime(2001, 1, 2)
>>> s = pl.Series("index", range(25))
>>> s
shape: (25,)
Series: 'index' [i64]
[
    0
    1
    2
    3
    4
    …
    20
    21
    22
    23
    24
]

Создайте другой ряд для применения маски окна:

>>> d = pl.Series("date", pl.datetime_range(start, stop, "1h", eager=True))
>>> d
shape: (25,)
Series: 'date' [datetime[μs]]
[
    2001-01-01 00:00:00
    2001-01-01 01:00:00
    2001-01-01 02:00:00
    2001-01-01 03:00:00
    2001-01-01 04:00:00
    …
    2001-01-01 20:00:00
    2001-01-01 21:00:00
    2001-01-01 22:00:00
    2001-01-01 23:00:00
    2001-01-02 00:00:00
]

Вычислите скользящую квантиль с временными окнами из второго ряда, правая граница которых включена:

>>> s.rolling_quantile_by(d, "3h", quantile=0.5)
shape: (25,)
Series: 'index' [f64]
[
    0.0
    1.0
    1.0
    2.0
    3.0
    …
    19.0
    20.0
    21.0
    22.0
    23.0
]