econml.metalearners.XLearner

class econml.metalearners.XLearner(*, models, cate_models=None, propensity_model=LogisticRegression(), categories='auto', allow_missing=False)[source]

基类: econml._cate_estimator.TreatmentExpansionMixin, econml._cate_estimator.LinearCateEstimator

Kunzel 等人提出的元算法，在以下场景中表现最佳：: 某个处理组中的单位数量远大于其他处理组。

参数

models (控制组和处理组的产出估计器) – 可以是一个应用于所有控制组和处理组的单个估计器，或者是一个估计器元组/列表，每个处理组（包括控制组）对应一个估计器。必须实现 fit 和 predict 方法。
cate_models (控制组和处理组伪处理效应的估计器) – 可以是一个应用于所有控制组和处理组的单个估计器，或者是一个估计器元组/列表，每个处理组（包括控制组）对应一个估计器。如果为 None，则与产出估计器使用相同的模型。必须实现 fit 和 predict 方法。
propensity_model (倾向函数估计器) – 必须实现 fit 和 predict_proba 方法。fit 方法必须能够接受 X 和 T 作为输入，其中 T 是一个形状为 (n, ) 的数组。
categories (‘auto’ 或 list, 默认值 ‘auto’) – 对离散处理进行编码时使用的类别（或使用 ‘auto’ 使用唯一排序的值）。第一个类别将被视为控制处理。
allow_missing (bool) – 是否允许 X 中存在缺失值。如果为 True，则需要提供能够处理缺失值的 models、cate_models 和 propensity_model。

示例

一个简单示例

from econml.metalearners import XLearner
from sklearn.linear_model import LinearRegression

np.random.seed(123)
X = np.random.normal(size=(1000, 5))
T = np.random.binomial(1, scipy.special.expit(X[:, 0]))
y = (1 + .5*X[:, 0]) * T + X[:, 0] + np.random.normal(size=(1000,))
est = XLearner(models=LinearRegression())
est.fit(y, T, X=X)

>>> est.effect(X[:3])
array([0.58547..., 1.82860..., 0.78379...])

__init__(*, models, cate_models=None, propensity_model=LogisticRegression(), categories='auto', allow_missing=False)[source]

方法

`__init__`(*, models[, cate_models, ...])
`ate`([X, T0, T1])	计算平均处理效应 \(E_X[\tau(X, T0, T1)]\)。
`ate_inference`([X, T0, T1])	模型产生的量 \(E_X[\tau(X, T0, T1)]\) 的推断结果。
`ate_interval`([X, T0, T1, alpha])	模型产生的量 \(E_X[\tau(X, T0, T1)]\) 的置信区间。
`cate_feature_names`([feature_names])	获取特征名称的公共接口。
`cate_output_names`([output_names])	获取输出名称的公共接口。
`cate_treatment_names`([treatment_names])	获取处理名称。
`const_marginal_ate`([X])	计算平均常数边际 CATE \(E_X[\theta(X)]\)。
`const_marginal_ate_inference`([X])	模型产生的量 \(E_X[\theta(X)]\) 的推断结果。
`const_marginal_ate_interval`([X, alpha])	模型产生的量 \(E_X[\theta(X)]\) 的置信区间。
`const_marginal_effect`(X)	计算每个样本特征向量的常数边际处理效应。
`const_marginal_effect_inference`([X])	模型产生的量 \(\theta(X)\) 的推断结果。
`const_marginal_effect_interval`([X, alpha])	模型产生的量 \(\theta(X)\) 的置信区间。
`effect`([X, T0, T1])	计算异质处理效应 \(\tau(X, T0, T1)\)。
`effect_inference`([X, T0, T1])	模型产生的量 \(\tau(X, T0, T1)\) 的推断结果。
`effect_interval`([X, T0, T1, alpha])	模型产生的量 \(\tau(X, T0, T1)\) 的置信区间。
`fit`(Y, T, *, X[, inference])	构建 XLearner 实例。
`marginal_ate`(T[, X])	计算平均边际效应 \(E_{T, X}[\partial\tau(T, X)]\)。
`marginal_ate_inference`(T[, X])	模型产生的量 \(E_{T,X}[\partial \tau(T, X)]\) 的推断结果。
`marginal_ate_interval`(T[, X, alpha])	模型产生的量 \(E_{T,X}[\partial \tau(T, X)]\) 的置信区间。
`marginal_effect`(T[, X])	计算异质边际效应 \(\partial\tau(T, X)\)。
`marginal_effect_inference`(T[, X])	模型产生的量 \(\partial \tau(T, X)\) 的推断结果。
`marginal_effect_interval`(T[, X, alpha])	模型产生的量 \(\partial \tau(T, X)\) 的置信区间。
`shap_values`(X, *[, feature_names, ...])	最终阶段模型 (const_marginal_effect) 的 Shap 值

属性

`dowhy`	获取 `DoWhyWrapper` 实例，以启用 dowhy 包的其他功能。（例如，因果图、反驳检验等）
`transformer`

ate(X=None, *, T0=0, T1=1)

计算平均处理效应 \(E_X[\tau(X, T0, T1)]\)。

效应在两个处理点之间计算，并对 X 变量总体进行平均。

参数

T0 ((m, d_t) 矩阵或长度为 m 的向量) – 每个样本的基础处理
T1 ((m, d_t) 矩阵或长度为 m 的向量) – 每个样本的目标处理
X ((m, d_x) 矩阵, 可选) – 每个样本的特征

返回

τ – 每个产出的平均处理效应注意，当 Y 是向量而不是二维数组时，结果将是一个标量

返回类型

float or (d_y,) array

ate_inference(X=None, *, T0=0, T1=1)

模型产生的量 \(E_X[\tau(X, T0, T1)]\) 的推断结果。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
T0 ((m, d_t) 矩阵或长度为 m 的向量, 默认值 0) – 每个样本的基础处理
T1 ((m, d_t) 矩阵或长度为 m 的向量, 默认值 1) – 每个样本的目标处理

返回

PopulationSummaryResults – 推断结果实例包含预测和预测标准误差，并可按需计算置信区间、z 统计量和 p 值。它还可以输出这些推断结果的 dataframe 摘要。

返回类型

对象

ate_interval(X=None, *, T0=0, T1=1, alpha=0.05)

模型产生的量 \(E_X[\tau(X, T0, T1)]\) 的置信区间。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
T0 ((m, d_t) 矩阵或长度为 m 的向量, 默认值 0) – 每个样本的基础处理
T1 ((m, d_t) 矩阵或长度为 m 的向量, 默认值 1) – 每个样本的目标处理
alpha ([0, 1] 范围内的浮点数, 默认值 0.05) – 报告区间的整体置信水平。报告 alpha/2, 1-alpha/2 置信区间。

返回

lower, upper – 每个量的置信区间的下界和上界。

返回类型

tuple( ate(X, T0, T1) 的类型, ate(X, T0, T1)) 的类型 )

cate_feature_names(feature_names=None)

获取特征名称的公共接口。

由对输入特征应用转换的估计器覆盖。

参数: feature_names (长度为 X.shape[1] 的字符串列表或 None) – 输入特征的名称。如果为 None 且 X 是 dataframe，则默认为 dataframe 的列名。
返回: out_feature_names – 返回特征名称。
返回类型: 字符串列表或 None

cate_output_names(output_names=None)

获取输出名称的公共接口。

由对输出应用转换的估计器覆盖。

参数: output_names (长度为 Y.shape[1] 的字符串列表或 None) – 产出的名称。如果为 None 且传递给 fit 的 Y 是 dataframe，则默认为 dataframe 的列名。
返回: output_names – 返回输出名称。
返回类型: 字符串列表

cate_treatment_names(treatment_names=None)

获取处理名称。

如果处理是离散的或特征化的，将返回展开的处理名称。

参数: treatment_names (长度为 T.shape[1] 的字符串列表, 可选) – 处理的名称。如果为 None 且传递给 fit 的 T 是 dataframe，则默认为 dataframe 的列名。
返回: out_treatment_names – 返回（可能已展开的）处理名称。
返回类型: 字符串列表

const_marginal_ate(X=None)

计算平均常数边际 CATE \(E_X[\theta(X)]\)。

参数: X ((m, d_x) 矩阵, 可选) – 每个样本的特征。
返回: theta – 每个处理对每个产出的平均常数边际 CATE。注意，当 Y 或特征化 T（如果 treatment_featurizer 为 None 则为 T）是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是一个标量）
返回类型: (d_y, d_f_t) 矩阵，其中 d_f_t 是特征化处理的维度。如果 treatment_featurizer 为 None，则 d_f_t = d_t。

const_marginal_ate_inference(X=None)

模型产生的量 \(E_X[\theta(X)]\) 的推断结果。仅在调用 fit 方法时 inference 不为 None 时可用。

参数: X ((m, d_x) 矩阵, 可选) – 每个样本的特征
返回: PopulationSummaryResults – 推断结果实例包含预测和预测标准误差，并可按需计算置信区间、z 统计量和 p 值。它还可以输出这些推断结果的 dataframe 摘要。
返回类型: 对象

const_marginal_ate_interval(X=None, *, alpha=0.05)

模型产生的量 \(E_X[\theta(X)]\) 的置信区间。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha ([0, 1] 范围内的浮点数, 默认值 0.05) – 报告区间的整体置信水平。报告 alpha/2, 1-alpha/2 置信区间。

返回

lower, upper – 每个量的置信区间的下界和上界。

返回类型

tuple( const_marginal_ate(X) 的类型 , const_marginal_ate(X) 的类型 )

const_marginal_effect(X)[source]

计算每个样本特征向量的常数边际处理效应。

参数: X (矩阵, 形状 (m × dₓ)) – 每个样本的特征矩阵。
返回: τ_hat – 每个处理对每个产出的常数边际 CATE，对应于每个样本 X[i]。注意，当 Y 是向量而不是二维数组时，输出中相应的单例维度将被折叠
返回类型: 矩阵, 形状 (m, d_y, d_t)

const_marginal_effect_inference(X=None)

模型产生的量 \(\theta(X)\) 的推断结果。仅在调用 fit 方法时 inference 不为 None 时可用。

参数: X ((m, d_x) 矩阵, 可选) – 每个样本的特征
返回: InferenceResults – 推断结果实例包含预测和预测标准误差，并可按需计算置信区间、z 统计量和 p 值。它还可以输出这些推断结果的 dataframe 摘要。
返回类型: 对象

const_marginal_effect_interval(X=None, *, alpha=0.05)

模型产生的量 \(\theta(X)\) 的置信区间。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha ([0, 1] 范围内的浮点数, 默认值 0.05) – 报告区间的整体置信水平。报告 alpha/2, 1-alpha/2 置信区间。

返回

lower, upper – 每个量的置信区间的下界和上界。

返回类型

tuple( const_marginal_effect(X) 的类型 , const_marginal_effect(X) 的类型 )

effect(X=None, *, T0=0, T1=1)

计算异质处理效应 \(\tau(X, T0, T1)\)。

效应在两个处理点之间计算，并以一组 m 个测试样本 \(\{T0_i, T1_i, X_i\}\) 的特征向量为条件。

参数

T0 ((m, d_t) 矩阵或长度为 m 的向量) – 每个样本的基础处理
T1 ((m, d_t) 矩阵或长度为 m 的向量) – 每个样本的目标处理
X ((m, d_x) 矩阵, 可选) – 每个样本的特征

返回

τ – 每个处理对每个产出的异质处理效应。注意，当 Y 是向量而不是二维数组时，相应的单例维度将被折叠（因此此方法将返回一个向量）

返回类型

(m, d_y) 矩阵

effect_inference(X=None, *, T0=0, T1=1)

模型产生的量 \(\tau(X, T0, T1)\) 的推断结果。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
T0 ((m, d_t) 矩阵或长度为 m 的向量, 默认值 0) – 每个样本的基础处理
T1 ((m, d_t) 矩阵或长度为 m 的向量, 默认值 1) – 每个样本的目标处理

返回

InferenceResults – 推断结果实例包含预测和预测标准误差，并可按需计算置信区间、z 统计量和 p 值。它还可以输出这些推断结果的 dataframe 摘要。

返回类型

对象

effect_interval(X=None, *, T0=0, T1=1, alpha=0.05)

模型产生的量 \(\tau(X, T0, T1)\) 的置信区间。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
T0 ((m, d_t) 矩阵或长度为 m 的向量, 默认值 0) – 每个样本的基础处理
T1 ((m, d_t) 矩阵或长度为 m 的向量, 默认值 1) – 每个样本的目标处理
alpha ([0, 1] 范围内的浮点数, 默认值 0.05) – 报告区间的整体置信水平。报告 alpha/2, 1-alpha/2 置信区间。

返回

lower, upper – 每个量的置信区间的下界和上界。

返回类型

tuple( effect(X, T0, T1) 的类型, effect(X, T0, T1)) 的类型 )

fit(Y, T, *, X, inference=None)[source]

构建 XLearner 实例。

参数

Y (array_like, 形状 (n, ) 或 (n, d_y)) – 处理策略的产出。
T (array_like, 形状 (n, ) 或 (n, 1)) – 处理策略。只接受二元处理作为输入。如果形状是 (n, 1)，T 将被展平。
X (array_like, 形状 (n, d_x)) – 捕捉异质性的特征向量。
inference (str, Inference 实例, 或 None) – 执行推断的方法。此估计器支持 ‘bootstrap’（或 BootstrapInference 实例）

返回

self

返回类型

self 的一个实例。

marginal_ate(T, X=None)

计算平均边际效应 \(E_{T, X}[\partial\tau(T, X)]\)。

边际效应围绕一个基础处理点计算，并对 X 的总体进行平均。

参数

T ((m, d_t) 矩阵) – 每个样本的基础处理
X ((m, d_x) 矩阵, 可选) – 每个样本的特征

返回

grad_tau – 每个产出的平均边际效应注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出将是一个标量）

返回类型

(d_y, d_t) 数组

marginal_ate_inference(T, X=None)

模型产生的量 \(E_{T,X}[\partial \tau(T, X)]\) 的推断结果。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

T ((m, d_t) 矩阵) – 每个样本的基础处理
X ((m, d_x) 矩阵, 可选) – 每个样本的特征

返回

PopulationSummaryResults – 推断结果实例包含预测和预测标准误差，并可按需计算置信区间、z 统计量和 p 值。它还可以输出这些推断结果的 dataframe 摘要。

返回类型

对象

marginal_ate_interval(T, X=None, *, alpha=0.05)

模型产生的量 \(E_{T,X}[\partial \tau(T, X)]\) 的置信区间。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

T ((m, d_t) 矩阵) – 每个样本的基础处理
X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha ([0, 1] 范围内的浮点数, 默认值 0.05) – 报告区间的整体置信水平。报告 alpha/2, 1-alpha/2 置信区间。

返回

lower, upper – 每个量的置信区间的下界和上界。

返回类型

tuple( marginal_ate(T, X) 的类型, marginal_ate(T, X) 的类型 )

marginal_effect(T, X=None)

计算异质边际效应 \(\partial\tau(T, X)\)。

边际效应围绕一个基础处理点计算，并以一组 m 个测试样本 \(\{T_i, X_i\}\) 的特征向量为条件。如果 treatment_featurizer 为 None，则在此计算中忽略基础处理，结果等同于 const_marginal_effect。

参数

T ((m, d_t) 矩阵) – 每个样本的基础处理
X ((m, d_x) 矩阵, 可选) – 每个样本的特征

返回

grad_tau – 每个产出对每个样本的异质边际效应注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是一个向量）

返回类型

(m, d_y, d_t) 数组

marginal_effect_inference(T, X=None)

模型产生的量 \(\partial \tau(T, X)\) 的推断结果。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

T ((m, d_t) 矩阵) – 每个样本的基础处理
X ((m, d_x) 矩阵, 可选) – 每个样本的特征

返回

InferenceResults – 推断结果实例包含预测和预测标准误差，并可按需计算置信区间、z 统计量和 p 值。它还可以输出这些推断结果的 dataframe 摘要。

返回类型

对象

marginal_effect_interval(T, X=None, *, alpha=0.05)

模型产生的量 \(\partial \tau(T, X)\) 的置信区间。仅在调用 fit 方法时 inference 不为 None 时可用。

参数

T ((m, d_t) 矩阵) – 每个样本的基础处理
X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha ([0, 1] 范围内的浮点数, 默认值 0.05) – 报告区间的整体置信水平。报告 alpha/2, 1-alpha/2 置信区间。

返回

lower, upper – 每个量的置信区间的下界和上界。

返回类型

tuple( marginal_effect(T, X) 的类型, marginal_effect(T, X) 的类型 )

shap_values(X, *, feature_names=None, treatment_names=None, output_names=None, background_samples=100)

最终阶段模型 (const_marginal_effect) 的 Shap 值

参数

X ((m, d_x) 矩阵) – 每个样本的特征。应与最终阶段 fitted X 的形状相同。
feature_names (长度为 X.shape[1] 的字符串列表, 可选) – 输入特征的名称。
treatment_names (list, 可选) – 特征化处理的名称。在离散处理场景中，名称不应包含基线处理（即控制处理，默认情况下是字母顺序较小的那个）的名称
output_names (list, 可选) – 产出的名称。
background_samples (int , 默认值 100) – 用于计算基线效应的样本数量。如果为 None，则使用所有样本。

返回

shap_outs – 一个嵌套字典，使用每个输出名称（例如，当 output_names=None 时为 ‘Y0’, ‘Y1’, …）和每个处理名称（例如，当 treatment_names=None 时为 ‘T0’, ‘T1’, …）作为键，shap_values 解释对象作为值。如果在 fit 时输入的数据也包含元数据（例如，是 pandas DataFrames），则使用处理、产出和特征的列元数据代替上述默认值（除非用户明确传递相应名称进行覆盖）。

返回类型

Explanation object 的嵌套字典

property dowhy

获取 DoWhyWrapper 实例，以启用 dowhy 包的其他功能。（例如，因果图、反驳检验等）

返回: DoWhyWrapper – DoWhyWrapper 的一个实例
返回类型: 实例