BoxCoxTransformer#

class feature_engine.transformation.BoxCoxTransformer(variables=None)[源代码][源代码]#

BoxCoxTransformer() 对数值变量应用 BoxCox 变换。

Box-Cox 变换定义为:

  • T(Y)=(Y exp(λ)−1)/λ 如果 λ!=0

  • log(Y) 否则

其中 Y 是响应变量,λ 是变换参数。λ 的取值范围通常从 -5 到 5。在变换过程中,所有 λ 的值都被考虑,并选择给定变量的最佳值。

此转换器实现的 BoxCox 变换是 SciPy.stats 中的变换: https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.boxcox.html

BoxCoxTransformer() 仅适用于数值型正变量 (>=0)。

可以传递一个变量列表作为参数。或者,转换器将自动选择并转换所有数值变量。

更多详情请参见 用户指南

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

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

属性
lambda_dict_

每个变量对应的最佳 BoxCox 指数的字典。

变量_

将被转换的变量组。

feature_names_in_:

列出在 fit 期间看到的特征名称。

n_features_in_:

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

参考文献

1

Box 和 Cox。“变换分析”。在 1964 年的研究会议上宣读。https://rss.onlinelibrary.wiley.com/doi/abs/10.1111/j.2517-6161.1964.tb00553.x

示例

>>> import numpy as np
>>> import pandas as pd
>>> from feature_engine.transformation import BoxCoxTransformer
>>> np.random.seed(42)
>>> X = pd.DataFrame(dict(x = np.random.lognormal(size = 100)))
>>> bct = BoxCoxTransformer()
>>> bct.fit(X)
>>> X = bct.transform(X)
>>> X.head()
          x
0  0.505485
1 -0.137595
2  0.662654
3  1.607518
4 -0.232237

方法

拟合:

学习BoxCox变换的最佳lambda值。

fit_transform:

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

get_feature_names_out:

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

get_params:

获取此估计器的参数。

设置参数:

设置此估计器的参数。

inverse_transform:

将数据转换回原始表示形式。

转换:

应用 BoxCox 变换。

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

学习BoxCox变换的最佳lambda值。

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

**fit_参数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: list

转换后的特征名称。

rtype

List[Union[str, int]] ..

get_metadata_routing()[源代码]#

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

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

返回
路由MetadataRequest

一个封装了路由信息的 MetadataRequest

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

获取此估计器的参数。

参数
深度bool, 默认=True

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

返回
参数dict

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

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

将数据转换回原始表示形式。

参数
X: Pandas DataFrame,形状为 = [样本数, 特征数]

要进行逆变换的数据。

返回
X_new: pandas 数据框

包含原始变量的数据框。

rtype

DataFrame ..

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

设置此估计器的参数。

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

参数
**参数dict

估计器参数。

返回
自身估计器实例

估计器实例。

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

应用 BoxCox 变换。

参数
X: Pandas DataFrame,形状为 = [样本数, 特征数]

要转换的数据。

返回
X_new: pandas 数据框

包含转换变量的数据框。

rtype

DataFrame ..