WindowFeatures#

class feature_engine.timeseries.forecasting.WindowFeatures(variables=None, window=3, min_periods=None, functions='mean', periods=1, freq=None, sort_index=True, missing_values='raise', drop_original=False, drop_na=False)[源代码][源代码]#

WindowFeatures 根据窗口操作向数据框添加新功能。窗口操作是对过去值的滑动分区执行聚合的操作。换句话说,窗口特征是在使用过去数据的窗口计算统计数据(例如,均值、最小值、最大值等)后创建的特征。例如,过去3个月数据的均值是一个窗口特征。过去三行数据的最大值是另一个窗口特征。

WindowFeatures 使用 pandas 函数 rolling()agg()shift()。通过 rolling(),它创建滚动窗口。通过 agg(),它在这些窗口内应用多个函数。通过 shift(),它将值分配到正确的行。

有关支持的聚合函数,请参阅滚动窗口 函数

通过 pandas 的 rolling() 方法,我们可以对一个窗口大小执行滚动操作。WindowFeatures 基于 pandas 的 rolling() 方法,可以从多个窗口大小中派生出新特征,并且创建的特征将自动连接到原始数据框。

为了与 WindowFeatures 兼容,数据框的索引必须具有唯一值且没有缺失数据。

WindowFeatures 仅适用于数值变量。您可以传递一个变量列表作为窗口的输入。或者,WindowFeatures 将自动选择训练集中的所有数值变量。

更多详情请参阅 用户指南

参数
变量: 列表, 默认=无

要转换的数值变量的列表。如果为 None,转换器将自动查找并选择所有数值变量。

window: int, offset, BaseIndexer 子类, 或 list, default=3

移动窗口的大小。如果是整数,则为每个窗口使用的固定观测数。如果是偏移量(推荐),则为每个窗口的时间周期。它也可以接受一个函数。更多详情请参见 pandas rolling() 文档中的参数 windows

除了 pandas 的常规输入值外,window 还可以接受一个包含上述指定值的列表,在这种情况下,将为列表中指定的每个窗口创建特征。

min_periods: int, 默认为 None.

窗口中所需的最小观测数以获得一个值;否则,结果为 np.nan。更多详情请参见 pandas rolling() 文档中的参数 min_periods

函数: 字符串或字符串列表, 默认 = ‘mean’

要在窗口内应用的函数。有效的函数可以在 这里 找到。

periods: int, list of ints, default=1

要移动的周期数。可以是正整数。参见 pandas shift() 中的参数 periods

freq: str, list of str, default=None

从 tseries 模块或时间规则使用的偏移量。参见 pandas shift() 中的参数 freq

sort_index: bool, default=True

是否在创建特征之前对数据框的索引进行排序。

missing_values: 字符串, 默认=’raise’

指示是否应忽略缺失值或引发错误。如果为 'raise',则当要 fittransform 的数据集包含缺失值时,转换器将返回错误。如果为 'ignore',则在学习参数或执行转换时将忽略缺失数据。

drop_original: bool, default=False

如果为 True,则转换的原始变量将从数据框中删除。

drop_na: bool, 默认为 False。

是否应移除滞后特征中引入的NAN。

属性
变量_

用于创建窗口特征的变量组。

feature_names_in_:

列出在 fit 过程中看到的特征名称。

n_features_in_:

用于拟合的训练集中的特征数量。

参见

pandas.rolling
pandas.aggregate
pandas.shift

示例

>>> import pandas as pd
>>> from feature_engine.timeseries.forecasting import WindowFeatures
>>> X = pd.DataFrame(dict(date = ["2022-09-18",
>>>                               "2022-09-19",
>>>                               "2022-09-20",
>>>                               "2022-09-21",
>>>                               "2022-09-22"],
>>>                       x1 = [1,2,3,4,5],
>>>                       x2 = [6,7,8,9,10]
>>>                     ))
>>> wf = WindowFeatures(window = 2)
>>> wf.fit_transform(X)
         date  x1  x2  x1_window_2_mean  x2_window_2_mean
0  2022-09-18   1   6               NaN               NaN
1  2022-09-19   2   7               NaN               NaN
2  2022-09-20   3   8               1.5               6.5
3  2022-09-21   4   9               2.5               7.5
4  2022-09-22   5  10               3.5               8.5

方法

拟合:

此转换器不学习参数。

转换:

添加窗口功能。

transform_x_y:

从 X 和 y 中移除包含缺失数据的行。

fit_transform:

拟合数据,然后进行转换。

get_feature_names_out:

获取转换的输出特征名称。

get_params:

获取此估计器的参数。

设置参数:

设置此估计器的参数。

fit(X, y=None)[源代码]#

此转换器不学习参数。

参数
X: 形状为 [n_samples, n_features] 的 pandas dataframe

训练数据集。

y: pandas Series, default=None

在这个转换器中不需要 y。你可以传递 None 或 y。

fit_transform(X, y=None, **fit_params)[源代码]#

拟合数据,然后进行转换。

使用可选参数 fit_params 将变换器拟合到 Xy,并返回 X 的变换版本。

参数
X类数组的形状 (n_samples, n_features)

输入样本。

y类数组,形状为 (n_样本,) 或 (n_样本, n_输出), 默认=None

目标值(无监督变换时为 None)。

**拟合参数dict

附加的拟合参数。

返回
X_newndarray 数组,形状为 (n_samples, n_features_new)

转换后的数组。

get_feature_names_out(input_features=None)[源代码]#

获取转换后的输出特征名称。换句话说,返回转换后的数据框的变量名称。

参数
input_features数组或列表,默认=None

此参数仅用于与 Scikit-learn 管道兼容。

  • 如果 None,则使用 feature_names_in_ 作为特征名称。

  • 如果是一个数组或列表,那么 input_features 必须与 feature_names_in_ 匹配。

返回
feature_names_out: 列表

转换后的特征名称。

rtype

List[Union[str, int]] ..

get_metadata_routing()[源代码]#

获取此对象的元数据路由。

请查看 用户指南 以了解路由机制的工作原理。

返回
路由MetadataRequest

一个封装了路由信息的 MetadataRequest

get_params(deep=True)[源代码]#

获取此估计器的参数。

参数
深度bool, 默认=True

如果为 True,将返回此估计器及其包含的作为估计器的子对象的参数。

返回
参数dict

参数名称映射到它们的值。

set_params(**params)[源代码]#

设置此估计器的参数。

该方法适用于简单的估计器以及嵌套对象(如 Pipeline)。后者具有 <component>__<parameter> 形式的参数,因此可以更新嵌套对象的每个组件。

参数
**参数dict

估计器参数。

返回
self估计器实例

估计器实例。

transform(X)[源代码][源代码]#

添加窗口特性。

参数
X: 形状为 [n_samples, n_features] 的 pandas dataframe

要转换的数据。

返回
X_new: Pandas 数据框, 形状 = [样本数, 特征数 + 窗口特征数]

包含原始变量和新变量的数据框。

rtype

DataFrame ..

transform_x_y(X, y)[源代码]#

根据应用于 X 的变换,对 X 和 y 进行变换、对齐和调整,确保如果从 X 中删除了任何行,它们对应于同一组行。

参数
X: 形状为 [n_samples, n_features] 的 pandas dataframe

要转换的数据框。

y: pandas Series 或 Dataframe,长度 = n_samples

要转换的目标变量。可以是多输出的。

返回
X_new: pandas 数据框

转换后的数据框,形状为 [n_samples - n_rows, n_features]。它可能比原始数据集的行数少。

y_new: pandas Series 或 DataFrame

转换后的目标变量,长度为 [n_samples - n_rows]。它包含的行数与 X_new 中剩余的行数相同。