DatetimeFeatures#

class feature_engine.datetime.DatetimeFeatures(variables=None, features_to_extract=None, drop_original=True, missing_values='raise', dayfirst=False, yearfirst=False, utc=None, format=None)[源代码][源代码]#

DatetimeFeatures 从日期时间变量中提取日期和时间特征,并将新列添加到数据集中。DatetimeFeatures 可以从现有的日期时间或类似对象的变量中提取日期时间信息,或者从数据框索引中提取。

DatetimeFeatures 使用 pandas.to_datetime 将对象变量转换为日期时间,并使用 pandas.dt 从日期时间中提取特征。

transformer 支持提取以下特征:

  • “月份”

  • quarter

  • 学期

  • “年”

  • day_of_week

  • day_of_month

  • day_of_year

  • “周末”

  • “month_start”

  • “month_end”

  • quarter_start

  • quarter_end

  • “year_start”

  • “year_end”

  • leap_year

  • days_in_month

  • 小时

  • “minute”

  • “第二”

更多详情请参阅 用户指南

参数
变量: str, list, 默认=None

从其中提取日期和时间信息的变量列表。如果为 None,转换器将查找并选择所有日期时间变量,包括可以转换为日期时间的对象类型变量。如果为 “index”,转换器将从数据框的索引中提取日期时间特征。

features_to_extract: list, default=None

要提取的日期特征列表。如果为 None,将提取以下特征:”month”、”year”、”day_of_week”、”day_of_month”、”hour”、”minute” 和 “second”。如果为 “all”,将提取所有支持的特征。或者,您可以传递一个包含您想要提取的特征名称的列表。

drop_original: bool, default=”True”

如果为真,原始的日期时间变量将从数据框中删除。

missing_values: string, default=’raise’

指示是否应忽略缺失值或引发错误。如果为 ‘raise’,当 fittransform 的数据集包含缺失值时,转换器将返回错误。如果为 ‘ignore’,在执行特征提取时将忽略缺失数据。缺失数据仅在用于推导日期和时间特征的变量中进行评估。如果特征是从数据框索引中派生的,则将在索引中检查缺失数据。

dayfirst: bool, 默认=”False”

如果 arg 是字符串或类似列表,请指定日期解析顺序。如果为 True,则先解析日期中的天,例如 10/11/12 解析为 2012-11-10。与 pandas.to_datetime 中的相同。

yearfirst: bool, 默认=”False”

如果 arg 是字符串或类似列表,请指定日期解析顺序。与 pandas.to_datetime 中的相同。

  • 如果为真,则以年份为先解析日期,例如 10/11/12 解析为 2010-11-12。

  • 如果 dayfirst 和 yearfirst 都为 True,则 yearfirst 优先。

utc: bool, default=None

如果为 True,则返回 UTC DatetimeIndex(同时转换任何 tz-aware 的 datetime.datetime 对象)。与 pandas.to_datetime 中的相同。

format: str, default None

用于解析时间的 strftime 格式,例如 “%d/%m/%Y”。有关更多选项,请查看 pandas 的 to_datetime() 文档。如果你有不同格式的变量,可以传递“mixed”,以单独推断每个元素的格式。这是有风险的,根据 pandas 的文档,你可能应该与 dayfirst 一起使用它。

属性
变量_

将从其中提取日期和时间特征的变量列表。如果为 None,则将从数据框索引中提取特征。

features_to_extract_:

将从每个变量或索引中提取的日期和时间特征。

feature_names_in_:

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

n_features_in_:

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

参见

pandas.to_datetime
pandas.dt

示例

>>> import pandas as pd
>>> from feature_engine.datetime import DatetimeFeatures
>>> X = pd.DataFrame(dict(date = ["2022-09-18", "2022-10-27", "2022-12-24"]))
>>> dtf = DatetimeFeatures(features_to_extract = ["year", "month", "day_of_month"])
>>> dtf.fit(X)
>>> dtf.transform(X)
    date_year  date_month  date_day_of_month
0       2022           9                 18
1       2022          10                 27
2       2022          12                 24

方法

拟合:

此转换器不学习参数。

fit_transform:

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

get_feature_names_out:

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

get_params:

获取此估计器的参数。

设置参数:

设置此估计器的参数。

转换:

添加日期和时间功能。

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

这个转换器不学习任何参数。

查找日期时间变量或检查用户选择的变量是否可以转换为日期时间。

参数
X: pandas 数据框,形状为 = [样本数, 特征数]

训练输入样本。可以是整个数据框,而不仅仅是需要转换的变量。

y: pandas Series, default=None

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

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

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

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

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

输入样本。

y类似数组的形状 (n_samples,) 或 (n_samples, n_outputs), 默认=None

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

**拟合参数dict

附加的拟合参数。

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

转换后的数组。

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

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

参数
输入特征数组或列表,默认=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

如果为真,将返回此估计器及其包含的子对象(这些子对象也是估计器)的参数。

返回
参数dict

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

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

设置此估计器的参数。

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

参数
**参数dict

估计器参数。

返回
self估计器实例

估计器实例。

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

提取日期和时间特征,并将它们添加到数据框中。

参数
X: pandas 数据框,形状为 = [样本数, 特征数]

要转换的数据。

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

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

rtype

DataFrame ..