相对特征#

class feature_engine.creation.RelativeFeatures(variables, reference, func, fill_value=None, missing_values='ignore', drop_original=False)[源代码][源代码]#

RelativeFeatures() 在变量组和一个或多个参考特征之间应用基本的数学运算。它将生成的特征添加到数据框中。

换句话说,RelativeFeatures() 对一组特征与一组参考变量进行加法、减法、乘法、除法、真除法、地板除法、取模或指数运算。这些函数产生的结果特征被添加到数据框中。

此转换器仅适用于数值变量。它使用 pandas 方法 pd.DataFrme.addpd.DataFrme.subpd.DataFrme.mulpd.DataFrme.divpd.DataFrme.truedivpd.DataFrme.floordivpd.DataFrme.modpd.DataFrme.pow。了解更多信息请参阅 pandas 文档

更多详情请参见 用户指南

参数
变量: 列表

要与参考变量组合的数值变量列表。

参考: 列表

将要添加、减去、乘以、用作除法和取模的分母,或用作幂运算的指数的引用变量列表。

函数: 列表

在转换中要使用的函数列表。列表可以包含以下字符串中的一个或多个:’add’, ‘mul’, ‘sub’, ‘div’, truediv, ‘floordiv’, ‘mod’, ‘pow’。

fill_value: int, float, default=None

当除以零时,此值用于代替无穷大。如果为 None,则在除以零时将引发错误。

missing_values: string, default=’raise’

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

drop_original: bool, default=False

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

属性
变量_

将被转换的变量组。

feature_names_in_:

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

n_features_in_:

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

注释

尽管转换器允许我们将任何特征与任何函数结合,但我们建议其用于创建领域知识变量。金融行业内的典型例子包括:

  • 收入与债务之间的比率,用于创建 debt_to_income_ratio。

  • 从收入中减去租金以获得可支配收入。

示例

>>> import pandas as pd
>>> from feature_engine.creation import RelativeFeatures
>>> X = pd.DataFrame(dict(x1 = [1,2,3], x2 = [4,5,6], x3 = [3,4,5]))
>>> rf = RelativeFeatures(variables = ["x1","x2"],
>>>                     reference = ["x3"],
>>>                     func = ["div"])
>>> rf.fit(X)
>>> rf.transform(X)
   x1  x2  x3  x1_div_x3  x2_div_x3
0   1   4   3   0.333333   1.333333
1   2   5   4   0.500000   1.250000
2   3   6   5   0.600000   1.200000

方法

拟合:

此转换器不学习参数。

fit_transform:

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

get_feature_names_out:

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

get_params:

获取此估计器的参数。

设置参数:

设置此估计器的参数。

变换:

创建新功能。

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

此转换器不学习参数。

参数
X: pandas 数据框,形状为 [n_samples, n_features]

训练输入样本。

y: pandas Series, 或 np.array. 默认为 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)[源代码]#

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

参数
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

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

返回
参数dict

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

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

设置此估计器的参数。

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

参数
**参数dict

估计器参数。

返回
自身估计器实例

估计器实例。

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

添加新功能。

参数
X: pandas 数据框,形状为 [n_samples, n_features]

要转换的数据。

返回
X_new: Pandas 数据框

输入的数据框加上新的变量。

rtype

DataFrame ..