econml.iv.dr.LinearIntentToTreatDRIV

类 econml.iv.dr.LinearIntentToTreatDRIV(*, model_y_xw='auto', model_t_xwz='auto', prel_cate_approach='driv', flexible_model_effect='auto', prel_cv=1, prel_opt_reweighted=True, z_propensity='auto', featurizer=None, fit_cate_intercept=True, discrete_outcome=False, cov_clip=0.001, cv=3, mc_iters=None, mc_agg='mean', opt_reweighted=False, categories='auto', random_state=None, allow_missing=False, enable_federation=False, use_ray=False, ray_remote_func_options=None)[源码]

基类: econml._cate_estimator.StatsModelsCateEstimatorMixin, econml.iv.dr._dr.IntentToTreatDRIV

实现了针对线性意向治疗 A/B 测试场景的 DRIV 算法

参数

model_y_xw (估计器, 默认为 'auto') – 确定如何将结果与特征和控制变量进行拟合 (\(\E[Y | X, W]\))。
- 如果为 'auto'，模型将从一组线性模型和森林模型中选择最佳拟合模型
- 否则，请参见模型选择以了解支持的选项范围；如果指定了单一模型，则当 discrete_outcome 为 True 时应为分类器，否则应为回归器
model_t_xwz (估计器, 默认为 'auto') – 确定如何将处理变量与特征、控制变量和工具变量进行拟合 (\(\E[T | X, W, Z]\))。
- 如果为 'auto'，模型将从一组线性模型和森林模型中选择最佳拟合模型
- 否则，请参见模型选择以了解支持的选项范围；如果指定了单一模型，则当 discrete_treatment 为 True 时应为分类器，否则应为回归器
flexible_model_effect (估计器或 ‘auto’ (默认为 ‘auto’)) – 用于初步版本 CATE 的灵活模型，在拟合时必须接受 sample_weight 参数。如果为 ‘auto’，则将应用 StatsModelsLinearRegression。
prel_cate_approach (以下之一：{‘driv’, ‘dmliv’}, 默认为 ‘driv’) – 估计初步版本 CATE 的模型。如果为 ‘driv’，则将使用 _DRIV。如果为 ‘dmliv’，则将使用 NonParamDMLIV
prel_cv (整数、交叉验证生成器或可迭代对象, 默认为 1) – 确定初步效应模型的交叉验证分割策略。
prel_opt_reweighted (布尔值, 默认为 True) – 是否对样本进行重新加权以最小化初步效应模型的方差。
z_propensity (浮点数或 “auto”, 默认为 “auto”) – 处理组在 A/B 测试中的比例。如果为 “auto”，我们假设工具变量是完全随机的，并且独立于任何其他变量。它计算为整体人群中 Z=1 的比例；如果输入比例，它必须是一个介于 0 到 1 之间的浮点数。
featurizer (转换器, 可选) – 必须支持 fit_transform 和 transform 方法。用于在最终的 CATE 回归中创建复合特征。如果 X 为 None 则忽略。最终 CATE 将基于 featurizer.fit_transform(X) 的结果进行训练。如果 featurizer=None，则 CATE 基于 X 进行训练。
fit_cate_intercept (布尔值, 默认为 True) – 线性 CATE 模型是否应包含常数项。
cov_clip (浮点数, 默认为 0.1) – 协变量在“重叠”区域较低的范围内的裁剪，以减少方差
cv (整数、交叉验证生成器或可迭代对象, 默认为 3) – 确定交叉验证的分割策略。cv 的可能输入包括
- None，使用默认的 3 折交叉验证，
- 整数，指定折数。
- CV 分割器
- 一个可迭代对象，生成以索引数组表示的 (训练集, 测试集) 分割。
对于整数/None 输入，如果处理变量是离散的，则使用 StratifiedKFold，否则使用 KFold（两种情况都会进行随机混洗）。

除非使用可迭代对象，否则我们调用 split(concat[W, X], T) 来生成分割。如果 W 和 X 都为 None，则我们调用 split(ones((T.shape[0], 1)), T)。
mc_iters (整数, 可选) – 重新运行第一阶段模型以减少干扰项方差的次数。
mc_agg ({‘mean’, ‘median’}, 默认为 ‘mean’) – 如何聚合在 mc_iters 次交叉拟合 Monte Carlo 迭代中每个样本的干扰项值。
opt_reweighted (布尔值, 默认为 False) – 是否对样本进行重新加权以最小化方差。如果为 True，则 final_model_effect.fit 必须接受 sample_weight 作为关键字参数（utilities 中的 WeightWrapper 可用于任何线性模型以启用样本权重）。如果为 True，则假设 final_model_effect 足够灵活以拟合真实的 CATE 模型。否则，该方法将返回一个对 model_effect 空间的有偏投影，该投影偏向于在工具变量较强的特征空间区域给予更高的权重。
categories (‘auto’ 或列表, 默认为 ‘auto’) – 对离散处理变量进行编码时使用的类别（或使用“auto”来使用唯一的排序值）。第一个类别将被视为对照处理。
random_state (整数、RandomState 实例或 None, 默认为 None) – 如果为整数，random_state 是随机数生成器使用的种子；如果为 RandomState 实例，random_state 是随机数生成器；如果为 None，随机数生成器是 RandomState 实例，使用 np.random。
allow_missing (布尔值) – 是否允许 W 中包含缺失值。如果为 True，将需要提供能处理缺失值的干扰项模型。
enable_federation (布尔值, 默认为 False) – 是否为最终模型启用联邦。这将产生内存成本，因此仅当该模型将与其他模型聚合时才应启用。
use_ray (布尔值, 默认为 False) – 是否使用 Ray 来并行化交叉验证步骤。如果为 True，必须安装 Ray。
ray_remote_func_options (字典, 默认为 None) – 使用 Ray 时传递给远程函数的选项。参见 https://docs.rayai.org.cn/en/latest/ray-core/api/doc/ray.remote.html

示例

使用默认模型的简单示例

from econml.iv.dr import LinearIntentToTreatDRIV

# Define the data generation functions
def dgp(n, p, true_fn):
    X = np.random.normal(0, 1, size=(n, p))
    Z = np.random.binomial(1, 0.5, size=(n,))
    nu = np.random.uniform(0, 10, size=(n,))
    coef_Z = 0.8
    C = np.random.binomial(
        1, coef_Z * scipy.special.expit(0.4 * X[:, 0] + nu)
    )  # Compliers when recomended
    C0 = np.random.binomial(
        1, 0.06 * np.ones(X.shape[0])
    )  # Non-compliers when not recommended
    T = C * Z + C0 * (1 - Z)
    y = true_fn(X) * T + 2 * nu + 5 * (X[:, 3] > 0) + 0.1 * np.random.uniform(0, 1, size=(n,))
    return y, T, Z, X

def true_heterogeneity_function(X):
    return 5 * X[:, 0]

np.random.seed(123)
y, T, Z, X = dgp(1000, 5, true_heterogeneity_function)
est = LinearIntentToTreatDRIV()
est.fit(Y=y, T=T, Z=Z, X=X)

>>> est.effect(X[:3])
array([-4.80489...,  6.10521... , -2.94904...])
>>> est.effect_interval(X[:3])
(array([-9.20176..., -0.47031... , -6.67354...]),
array([-0.40802..., 12.68073...,  0.77546...]))
>>> est.coef_
array([ 5.52418...,  0.96276...,  0.68158..., -0.16803..., -0.13056...])
>>> est.coef__interval()
(array([ 3.61373..., -0.81856..., -1.12589..., -1.90193... , -1.92331...]),
array([7.43462..., 2.74409... , 2.48906..., 1.56587..., 1.66218...]))
>>> est.intercept_
-0.28940...
>>> est.intercept__interval()
(-2.07653..., 1.49771...)

__init__(*, model_y_xw='auto', model_t_xwz='auto', prel_cate_approach='driv', flexible_model_effect='auto', prel_cv=1, prel_opt_reweighted=True, z_propensity='auto', featurizer=None, fit_cate_intercept=True, discrete_outcome=False, cov_clip=0.001, cv=3, mc_iters=None, mc_agg='mean', opt_reweighted=False, categories='auto', random_state=None, allow_missing=False, enable_federation=False, use_ray=False, ray_remote_func_options=None)[源码]

方法

`__init__`(*[, model_y_xw, model_t_xwz, ...])
`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])	获取处理名称。
`coef__inference`()	常数边际处理效应线性模型中系数的推断。
`coef__interval`(*[, alpha])	常数边际处理效应线性模型中的系数。
`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])	计算常数边际 CATE \(\theta(·)\)。
`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, *, Z[, X, W, sample_weight, ...])	从数据中估计反事实模型，即估计函数 \(\theta(\cdot)\)。
`intercept__inference`()	常数边际处理效应线性模型中截距的推断。
`intercept__interval`(*[, alpha])	常数边际处理效应线性模型中的截距。
`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)\) 的置信区间。
`refit_final`(*[, inference])	使用新的最终模型规范重新估计反事实模型，但使用缓存的第一阶段结果。
`score`(Y, T, Z[, X, W, sample_weight])	在新数据集上评估拟合的 CATE 模型。
`shap_values`(X, *[, feature_names, ...])	最终阶段模型 (const_marginal_effect) 的 Shap 值
`summary`([alpha, value, decimals, ...])	常数边际处理效应线性模型中系数和截距的摘要。

属性

`bias_part_of_coef`
`coef_`	常数边际处理效应线性模型中的系数。
`dowhy`	获取 `DoWhyWrapper` 的实例，以允许使用 dowhy 包的其他功能。
`featurizer`
`featurizer_`	获取拟合的特征化器。
`fit_cate_intercept_`
`intercept_`	常数边际处理效应线性模型中的截距。
`model_cate`	获取拟合的最终 CATE 模型。
`model_final`
`model_final_`
`models_nuisance_`
`models_prel_model_effect`	获取拟合的初步 CATE 估计器。
`models_t_xwz`	获取 \(\E[T \| X, Z]\) 的拟合模型。
`models_y_xw`	获取 \(\E[Y \| X]\) 的拟合模型。
`nuisance_scores_prel_model_effect`	获取 prel_model_effect 模型在样本外训练数据上的得分
`nuisance_scores_t_xwz`	获取 t_xw 模型在样本外训练数据上的得分
`nuisance_scores_y_xw`	获取 y_xw 模型在样本外训练数据上的得分
`original_featurizer`
`ortho_learner_model_final_`
`residuals_`	一个元组 (prel_theta, Y_res, T_res, Z_res, cov, X, W, Z)，包含第一阶段估计的残差以及相关的 X、W 和 Z。
`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 是向量而不是二维数组时，结果将是一个标量

返回类型

浮点数或 (d_y,) 数组

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 – 每个数量的置信区间的下界和上界。

返回类型

元组(类型 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 – 输出特征 \(\phi(X)\) 的名称，即最终 CATE 模型对每个处理变量呈线性的特征。这些名称与 coef_() 参数的每个条目关联的特征名称。仅当 featurizer 不为 None 且具有方法：get_feature_names(feature_names) 时可用。否则返回 None。
返回类型: 字符串列表或 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 – 返回（可能已扩展的）处理名称。
返回类型: 字符串列表

coef__inference()

常数边际处理效应线性模型中系数的推断。

返回: InferenceResults – 最终线性模型中系数的推断
返回类型: 对象

coef__interval(*, alpha=0.05)

常数边际处理效应线性模型中的系数。

参数: alpha (浮点数, 在 [0, 1] 之间, 默认为 0.05) – 报告区间的总体置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。
返回: lb, ub – 每个数量的置信区间的下界和上界。
返回类型: 元组(类型 coef_(), 类型 coef_())

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 – 每个数量的置信区间的下界和上界。

返回类型

元组(类型 const_marginal_ate(X) , 类型 const_marginal_ate(X) )

const_marginal_effect(X=None)

计算常数边际 CATE \(\theta(·)\)。

边际效应以一组 m 个测试样本 X[i] 上的特征向量为条件。

参数: X ((m, d_x) 矩阵, 可选) – 每个样本的特征。
返回: theta – 对于每个样本 X[i]，每个特征化处理变量对每个结果的常数边际 CATE。注意，当 Y 或特征化后的 T（如果 treatment_featurizer 为 None，则为 T）是向量而不是二维数组时，输出中相应的单例维度将折叠（例如，如果两者都是向量，则此方法的输出也将是向量）
返回类型: (m, d_y, d_f_t) 矩阵或当 X 为 None 时的 (d_y, d_f_t) 矩阵，其中 d_f_t 是特征化处理变量的维度。如果 treatment_featurizer 为 None，则 d_f_t = 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 – 每个数量的置信区间的下界和上界。

返回类型

元组(类型 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 – 每个数量的置信区间的下界和上界。

返回类型

元组(类型 effect(X, T0, T1), 类型 effect(X, T0, T1)) )

fit(Y, T, *, Z, X=None, W=None, sample_weight=None, freq_weight=None, sample_var=None, groups=None, cache_values=False, inference='auto')[源码]

从数据中估计反事实模型，即估计函数 \(\theta(\cdot)\)。

参数

Y ((n, d_y) 矩阵或长度为 n 的向量) – 每个样本的结果
T ((n, d_t) 矩阵或长度为 n 的向量) – 每个样本的处理变量
Z ((n, d_z) 矩阵或长度为 n 的向量) – 每个样本的工具变量
X ((n, d_x) 矩阵, 可选) – 每个样本的特征
W ((n, d_w) 矩阵, 可选) – 每个样本的控制变量
sample_weight ((n,) 数组状或 None) – 每个样本的个体权重。如果为 None，则假定权重相等。
freq_weight ((n,) 整数数组状, 可选) – 观测值的权重。观测值 i 被视为 freq_weight[i] 个独立观测值的平均结果。当 sample_var 不为 None 时，应提供此参数。
sample_var ((n,) nd 数组状, 可选) – 用于计算观测值 i 所代表的平均结果的原始 freq_weight[i] 个观测值的结果方差。
groups ((n,) 向量, 可选) – 对应于同一组的所有行在分割时将保持在一起。如果 groups 不为 None，则传递给此类初始化器的 cv 参数必须支持其 split 方法的 ‘groups’ 参数。
cache_values (布尔值, 默认为 False) – 是否缓存输入和第一阶段结果，这将允许使用不同的最终模型重新拟合
inference (字符串, .Inference 实例, 或 None) – 执行推断的方法。此估计器支持 ‘bootstrap’（或 .BootstrapInference 实例）和 ‘statsmodels’（或 StatsModelsInference 实例）。

返回

self

返回类型

实例

intercept__inference()

常数边际处理效应线性模型中截距的推断。

返回: InferenceResults – 最终线性模型中截距的推断
返回类型: 对象

intercept__interval(*, alpha=0.05)

常数边际处理效应线性模型中的截距。

参数: alpha (浮点数, 在 [0, 1] 之间, 默认为 0.05) – 报告区间的总体置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。
返回: lower, upper – 置信区间的下界和上界。
返回类型: 元组(类型 intercept_(), 类型 intercept_())

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 – 每个数量的置信区间的下界和上界。

返回类型

元组(类型 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 – 每个数量的置信区间的下界和上界。

返回类型

元组(类型 marginal_effect(T, X), 类型 marginal_effect(T, X) )

refit_final(*, inference='auto')

使用新的最终模型规范重新估计反事实模型，但使用缓存的第一阶段结果。

为了成功，fit 方法必须在调用时设置 cache_values=True。此调用仅重新拟合最终模型。此调用将使用更改最终阶段估计的任何参数的当前设置。如果更改第一阶段干扰项估计方式的任何参数也已更改，则不会产生影响。您需要再次调用 fit 方法来更改第一阶段估计结果。

参数: inference (推断方法, 可选) – 表示推断方法的字符串或对象
返回: self – 此实例
返回类型: 对象

score(Y, T, Z, X=None, W=None, sample_weight=None)

在一个新数据集上对拟合好的 CATE 模型进行评分。基于在拟合时创建的残差干扰模型，为新数据集生成干扰参数。它使用不同交叉拟合（crossfit）折叠拟合的模型预测的平均值。然后计算最终残差 Y 对残差 T 回归的 MSE。

如果 model_final 没有 score 方法，则会引发 AttributeError

参数

Y ((n, d_y) 矩阵或长度为 n 的向量) – 每个样本的结果
T ((n, d_t) 矩阵或长度为 n 的向量) – 每个样本的处理变量
Z ((n, d_z) 矩阵) – 每个样本的工具变量
X ((n, d_x) 矩阵, 可选) – 每个样本的特征
W ((n, d_w) 矩阵, 可选) – 每个样本的控制变量
sample_weight ((n,) 向量, 可选) – 每个样本的权重

返回

score – 最终 CATE 模型在新数据上的 MSE。

返回类型

浮点数

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

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

参数

X ((m, d_x) 矩阵) – 每个样本的特征。形状应与最终阶段拟合的 X 形状相同。
feature_names (长度为 X.shape[1] 的字符串列表, 可选) – 输入特征的名称。
treatment_names (列表, 可选) – 特征化处理的名称。在离散处理场景中，名称不应包含基线处理（即对照处理，默认按字母顺序排在前面）的名称
output_names (列表, 可选) – 结果变量的名称。
background_samples (整数, 默认 100) – 用于计算基线效应的样本数量。如果为 None，则使用所有样本。

返回

shap_outs – 一个嵌套字典，使用每个输出名称（例如当 output_names=None 时为 'Y0'、'Y1' 等）和每个处理名称（例如当 treatment_names=None 时为 'T0'、'T1' 等）作为键，以 shap_values explanation 对象作为值。如果在拟合时输入数据也包含元数据（例如 pandas DataFrames），则使用处理、结果变量和特征的列元数据，而不是上述默认值（除非用户通过显式传递相应的名称来覆盖）。

返回类型

Explanation 对象的嵌套字典

summary(alpha=0.05, value=0, decimals=3, feature_names=None, treatment_names=None, output_names=None)

常数边际处理效应线性模型中系数和截距的摘要。

参数

alpha (浮点数, 在 [0, 1] 之间, 默认为 0.05) – 报告区间的总体置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。
value (浮点数, 默认 0) – 在零假设下您希望测试的指标的平均值。
decimals (整数, 默认 3) – 每列四舍五入到的小数位数。
feature_names (字符串列表, 可选) – 特征名称的输入
treatment_names (字符串列表, 可选) – 处理名称
output_names (字符串列表, 可选) – 输出名称

返回

smry – 这包含摘要表格和文本，可以打印或转换为各种输出格式。

返回类型

Summary 实例

property coef_

常数边际处理效应线性模型中的系数。

返回: coef – 其中 n_x 是进入最终模型的特征数量（如果 CATE 估计器有 featurizer，则为 X 的维度或 featurizer.fit_transform(X) 的维度），n_t 是处理数量，n_y 是结果变量数量。如果原始输入是向量而不是 2D 数组，则省略维度。对于二元处理，也省略 n_t 维度。
返回类型: (n_x,) 或 (n_t, n_x) 或 (n_y, n_t, n_x) array_like

property dowhy

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

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

property featurizer_

获取拟合的特征化器。

返回: featurizer – 在最终 CATE 模型训练中用于预处理 X 的已拟合 featurizer 实例。仅当 featurizer 非 None 且 X 非 None 时可用。
返回类型: 类型为 (featurizer) 的对象

property intercept_

常数边际处理效应线性模型中的截距。

返回: intercept – 其中 n_t 是处理数量，n_y 是结果变量数量。如果原始输入是向量而不是 2D 数组，则省略维度。对于二元处理，也省略 n_t 维度。
返回类型: 浮点数或 (n_y,) 或 (n_y, n_t) array_like

property model_cate

获取拟合的最终 CATE 模型。

返回: model_cate – 在调用 fit 后拟合的 model_final 实例，对应于常数边际 CATE 模型。
返回类型: 类型为 (model_final) 的对象

property models_prel_model_effect

获取拟合的初步 CATE 估计器。

返回: prel_model_effect – prel_model_effect 实例的嵌套列表。子列表数量等于蒙特卡罗迭代次数，子列表中的每个元素对应一个交叉拟合折叠，并且是为该训练折叠拟合的模型实例。
返回类型: 类型为 (prel_model_effect) 的对象的嵌套列表

property models_t_xwz

获取 \(\E[T | X, Z]\) 的拟合模型。

返回: models_t_xwz – model_t_xwz 实例的嵌套列表。子列表数量等于蒙特卡罗迭代次数，子列表中的每个元素对应一个交叉拟合折叠，并且是为该训练折叠拟合的模型实例。
返回类型: 类型为 (model_t_xwz) 的对象的嵌套列表

property models_y_xw

获取 \(\E[Y | X]\) 的拟合模型。

返回: models_y_xw – model_y_xw 实例的嵌套列表。子列表数量等于蒙特卡罗迭代次数，子列表中的每个元素对应一个交叉拟合折叠，并且是为该训练折叠拟合的模型实例。
返回类型: 类型为 (model_y_xw) 的对象的嵌套列表

property nuisance_scores_prel_model_effect: 获取 prel_model_effect 模型在样本外训练数据上的得分

property nuisance_scores_t_xwz: 获取 t_xw 模型在样本外训练数据上的得分

property nuisance_scores_y_xw: 获取 y_xw 模型在样本外训练数据上的得分

property residuals_: 一个元组 (prel_theta, Y_res, T_res, Z_res, cov, X, W, Z)，包含来自第一阶段估计的残差以及相关的 X、W 和 Z。不能保证样本顺序与输入顺序相同。