LagFeatures#
- class feature_engine.timeseries.forecasting.LagFeatures(variables=None, periods=1, freq=None, fill_value=None, sort_index=True, missing_values='raise', drop_original=False, drop_na=False)[源代码][源代码]#
LagFeatures 向数据框添加滞后特征。滞后特征是包含先前时间步信息的特征。
LagFeatures 的功能与 pandas 的
shift()相同，但一次只能指定periods或freq中的一个。LagFeatures 基于 pandas 的shift()，可以在同一时间创建多个滞后，并且具有名称的特征将被连接到原始数据框。为了与 LagFeatures 兼容，数据框的索引必须具有唯一值且没有 NaN。
LagFeatures 仅适用于数值变量。您可以传递一个变量列表进行滞后处理。或者，LagFeatures 将自动选择并滞后训练集中找到的所有数值变量。
更多详情请参阅 用户指南。
- 参数
- 变量: 列表, 默认=无
要转换的数值变量的列表。如果为 None，转换器将自动查找并选择所有数值变量。
- periods: int, list of ints, default=1
要移动的周期数。可以是正整数或正整数列表。如果是列表，将为列表中的每个周期创建特征。如果指定了参数
freq，则periods将被忽略。- freq: str, list of str, default=None
从 tseries 模块或时间规则使用的偏移量。参见 pandas
shift()中的参数freq。它具有相同的功能。如果 freq 是一个列表，将为列表中的每个频率值创建滞后特征。如果 freq 不是 None，则此参数将覆盖参数periods。- fill_value: 对象, 可选
用于新引入的缺失值的标量值。默认值取决于变量的数据类型。对于数值数据，使用 np.nan。对于日期时间、时间增量或周期数据，使用 NaT。对于扩展数据类型，使用 self.dtype.na_value。
- sort_index: bool, default=True
是否在创建滞后特征之前对数据框的索引进行排序。
- missing_values: string, default=’raise’
指示是否应忽略缺失值或引发异常。如果为
'raise'，当fit或transform的数据集包含缺失值时，转换器将返回错误。如果为'ignore'，在学习参数或执行转换时将忽略缺失数据。- drop_original: bool, default=False
如果为真，转换的原始变量将从数据框中删除。
- drop_na: bool, 默认为 False.
是否应移除滞后特征中引入的NAN。
- 属性
- 变量_
将被滞后的变量组。
- feature_names_in_:
列出在
fit过程中观察到的特征名称。- n_features_in_:
在拟合过程中使用的训练集中的特征数量。
参见
pandas.shift
示例
>>> import pandas as pd >>> from feature_engine.timeseries.forecasting import LagFeatures >>> 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] >>> )) >>> lf = LagFeatures(periods=[1,2]) >>> lf.fit_transform(X) date x1 x2 x1_lag_1 x2_lag_1 x1_lag_2 x2_lag_2 0 2022-09-18 1 6 NaN NaN NaN NaN 1 2022-09-19 2 7 1.0 6.0 NaN NaN 2 2022-09-20 3 8 2.0 7.0 1.0 6.0 3 2022-09-21 4 9 3.0 8.0 2.0 7.0 4 2022-09-22 5 10 4.0 9.0 3.0 8.0
方法
拟合：
此转换器不学习参数。
fit_transform:
拟合数据，然后进行转换。
get_feature_names_out:
获取转换后的输出特征名称。
get_params:
获取此估计器的参数。
设置参数:
设置此估计器的参数。
转换:
添加滞后特征。
transform_x_y:
从 X 和 y 中移除含有缺失数据的行。
- fit(X, y=None)[源代码]#
此转换器不学习参数。
- 参数
- X: pandas 数据框，形状为 = [样本数, 特征数]
训练数据集。
- y: pandas Series, default=None
在这个转换器中，y 不是必需的。你可以传递 None 或 y。
- fit_transform(X, y=None, **fit_params)[源代码]#
拟合数据，然后进行转换。
使用可选参数
fit_params将转换器拟合到X和y，并返回X的转换版本。- 参数
- X类似数组的形状 (n_samples, n_features)
输入样本。
- y形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组对象，默认=None
目标值（无监督变换时为 None）。
- **拟合参数dict
附加的拟合参数。
- 返回
- X_newndarray 数组的形状为 (n_samples, n_features_new)
转换后的数组。
- get_metadata_routing()[源代码]#
获取此对象的元数据路由。
请查看 用户指南 以了解路由机制的工作原理。
- 返回
- 路由MetadataRequest
一个封装了路由信息的
MetadataRequest。
- get_params(deep=True)[源代码]#
获取此估计器的参数。
- 参数
- 深度bool, 默认=True
如果为真，将返回此估计器及其包含的作为估计器的子对象的参数。
- 返回
- 参数dict
参数名称映射到它们的值。
- set_params(**params)[源代码]#
设置此估计器的参数。
该方法适用于简单的估计器以及嵌套对象（如
Pipeline）。后者具有<component>__<parameter>形式的参数，因此可以更新嵌套对象的每个组件。- 参数
- **参数dict
估计器参数。
- 返回
- self估计器实例
估计器实例。
- transform(X)[源代码][源代码]#
添加滞后特征。
- 参数
- X: pandas 数据框，形状为 = [样本数, 特征数]
要转换的数据。
- 返回
- X_new: Pandas 数据框, 形状 = [样本数, 特征数 + 滞后特征数]
包含原始变量和新变量的数据框。
- rtype
DataFrame..
- transform_x_y(X, y)[源代码]#
基于应用于 X 的变换，对 X 和 y 进行变换、对齐和调整，确保如果从 X 中删除了任何行，它们对应于相同的一组行。
- 参数
- X: pandas 数据框，形状为 = [样本数, 特征数]
要转换的数据框。
- 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 中剩余的行数相同。