econml.iv.dml.OrthoIV

class econml.iv.dml.OrthoIV(*, model_y_xw='auto', model_t_xw='auto', model_t_xwz='auto', model_z_xw='auto', projection=False, featurizer=None, fit_cate_intercept=True, discrete_outcome=False, discrete_treatment=False, treatment_featurizer=None, discrete_instrument=False, categories='auto', cv=2, mc_iters=None, mc_agg='mean', random_state=None, allow_missing=False)[source]

基类：econml._cate_estimator.LinearModelFinalCateEstimatorMixin, econml._ortho_learner._OrthoLearner

实现了第 4.2 节中描述的用于 IV 的 CATE 估计的正交/双重机器学习方法

双重/去偏机器学习用于处理和因果参数 Victor Chernozhukov, Denis Chetverikov, Mert Demirer, Esther Duflo, Christian Hansen, Whitney Newey, James Robins https://arxiv.org/abs/1608.00060

求解以下矩方程

\[\E[(Y-\E[Y|X]-\theta(X) * (T-\E[T|X]))(Z-\E[Z|X])] = 0\]

参数

model_y_xw (估计器, 默认为 'auto') – 确定如何将结果与特征和控制变量进行拟合 (\(\E[Y | X, W]\))。
- 如果为 'auto'，则模型将是线性模型和森林模型集合中拟合最好的模型
- 否则，请参阅模型选择以了解支持的选项范围；如果指定了单个模型，则在 discrete_outcome 为 True 时应为分类器，否则为回归器
model_t_xw (估计器, 默认为 'auto') – 确定如何将处理与特征和控制变量进行拟合 (\(\E[T | X, W]\))。
- 如果为 'auto'，则模型将是线性模型和森林模型集合中拟合最好的模型
- 否则，请参阅模型选择以了解支持的选项范围；如果指定了单个模型，则在 discrete_treatment 为 True 时应为分类器，否则为回归器
model_t_xwz (估计器, 默认为 'auto') – 确定如何将处理与特征、控制变量和工具变量进行拟合 (\(\E[T | X, W, Z]\))。
- 如果为 'auto'，则模型将是线性模型和森林模型集合中拟合最好的模型
- 否则，请参阅模型选择以了解支持的选项范围；如果指定了单个模型，则在 discrete_treatment 为 True 时应为分类器，否则为回归器
model_z_xw (估计器, 默认为 'auto') – 确定如何将工具变量与特征和控制变量进行拟合 (\(\E[Z | X, W]\))。
- 如果为 'auto'，则模型将是线性模型和森林模型集合中拟合最好的模型
- 否则，请参阅模型选择以了解支持的选项范围；如果指定了单个模型，则在 discrete_instrument 为 True 时应为分类器，否则为回归器
projection (布尔值, 默认为 False) – 如果为 True，我们拟合 OrthoIV 的一个略微变体，其中我们将 E[T|X, W, Z] 用作工具变量而不是 Z，model_z_xw 将被禁用；如果为 False，model_t_xwz 将被禁用。
featurizer (转换器, 可选) – 必须支持 fit_transform 和 transform 方法。用于在最终 CATE 回归中创建复合特征。如果 X 为 None，则忽略此参数。最终 CATE 将在 featurizer.fit_transform(X) 的输出上训练。如果 featurizer=None，则 CATE 在 X 上训练。
fit_cate_intercept (布尔值, 默认为 False) – 线性 CATE 模型是否应包含常数项。
discrete_outcome (布尔值, 默认为 False) – 结果是否应被视为二元变量
discrete_treatment (布尔值, 默认为 False) – 处理值是否应被视为类别型而非连续型变量
treatment_featurizer (转换器, 可选) – 必须支持 fit_transform 和 transform 方法。用于在最终 CATE 回归中创建复合处理。最终 CATE 将在 featurizer.fit_transform(T) 的输出上训练。如果 featurizer=None，则 CATE 在 T 上训练。
discrete_instrument (布尔值, 默认为 False) – 工具变量值是否应被视为类别型而非连续型变量
categories (‘auto’ 或 list, 默认为 ‘auto’) – 对离散处理进行编码时使用的类别（或 ‘auto’ 使用唯一排序值）。第一个类别将被视为对照处理。
cv (整型, 交叉验证生成器或可迭代对象, 默认为 2) – 确定交叉验证的分割策略。cv 的可能输入为
- None，使用默认的 3 折交叉验证，
- 整型，指定折数。
- CV 分割器
- 一个生成 (train, test) 分割作为索引数组的可迭代对象。
对于整型/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 次蒙特卡洛交叉拟合迭代中聚合每个样本的干扰项值。
random_state (整型, RandomState 实例或 None, 默认为 None) – 如果是整型，random_state 是随机数生成器使用的种子；如果是RandomState 实例，random_state 是随机数生成器；如果为 None，随机数生成器是 np.random 使用的 RandomState 实例。
allow_missing (布尔值) – 是否允许 W 中存在缺失值。如果为 True，则需要提供可以处理缺失值的干扰项模型。

示例

使用默认模型的一个简单示例

from econml.iv.dml import OrthoIV

# 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 = OrthoIV(discrete_treatment=True, discrete_instrument=True)
est.fit(Y=y, T=T, Z=Z, X=X)

>>> est.effect(X[:3])
array([-4.28045... ,  6.02945..., -2.86851...])
>>> est.effect_interval(X[:3])
(array([-7.20729...,  1.75412..., -5.20897...]),
array([-1.35361..., 10.30478..., -0.52805...]))
>>> est.coef_
array([ 4.51659...,  0.78512...,  0.23706...,  0.24126... , -0.47167...])
>>> est.coef__interval()
(array([ 3.15602..., -0.35785..., -0.89798..., -0.90530..., -1.62445...]),
array([5.87715... , 1.92810... , 1.37211..., 1.38783..., 0.68110...]))
>>> est.intercept_
-0.13672...
>>> est.intercept__interval()
(-1.27036..., 0.99690...)

__init__(*, model_y_xw='auto', model_t_xw='auto', model_t_xwz='auto', model_z_xw='auto', projection=False, featurizer=None, fit_cate_intercept=True, discrete_outcome=False, discrete_treatment=False, treatment_featurizer=None, discrete_instrument=False, categories='auto', cv=2, mc_iters=None, mc_agg='mean', random_state=None, allow_missing=False)[source]

方法

`__init__`(*[, model_y_xw, model_t_xw, ...])
`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_`	获取已拟合的 featurizer。
`fit_cate_intercept_`
`intercept_`	常数边际处理效应线性模型中的截距。
`model_cate`	获取已拟合的最终 CATE 模型。
`model_final`
`model_final_`
`models_nuisance_`
`models_t_xw`	获取 \(\E[T \| X]\) 的已拟合模型。
`models_t_xwz`	获取 \(\E[T \| X, Z]\) 的已拟合模型。
`models_y_xw`	获取 \(\E[Y \| X]\) 的已拟合模型。
`models_z_xw`	获取 \(\E[Z \| X]\) 的已拟合模型。
`nuisance_scores_t_xw`	获取 t_xw 模型在样本外训练数据上的得分
`nuisance_scores_t_xwz`	获取 t_xwz 模型在样本外训练数据上的得分
`nuisance_scores_y_xw`	获取 y_xw 模型在样本外训练数据上的得分
`nuisance_scores_z_xw`	获取 z_xw 模型在样本外训练数据上的得分
`original_featurizer`
`ortho_learner_model_final_`
`residuals_`	一个元组 (y_res, T_res, Z_res, 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 – 每个数量的置信区间的下限和上限。

返回类型

tuple(type of ate(X, T0, T1), type of ate(X, T0, T1)) )

cate_feature_names(feature_names=None)[source]

获取输出特征名称。

参数: 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 – 每个数量的置信区间的下限和上限。
返回类型: tuple(type of coef_(), type of 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 – 每个数量的置信区间的下限和上限。

返回类型

tuple(type of const_marginal_ate(X) , type of const_marginal_ate(X) )

const_marginal_effect(X=None)

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

边际效应是针对一组 m 个测试样本 X[i] 条件于特征向量计算的。

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

返回类型

tuple(type of const_marginal_effect(X) , type of 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(type of effect(X, T0, T1), type of 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')[source]

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

参数

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,) array_like，可选) – 每个样本的个体权重。如果为 None，则假定权重相等。
freq_weight ((n,) array_like of int，可选) – 观测值的权重。观测值 i 被视为 freq_weight[i] 个独立观测值的平均结果。当 sample_var 不为 None 时，应提供此参数。
sample_var ({(n,), (n, d_y)} nd array_like，可选) – 用于计算由观测值 i 代表的平均结果的原始 freq_weight[i] 个观测值的结果变量的方差。
groups ((n,) 向量，可选) – 对应于同一组的所有行将在拆分过程中保持在一起。如果 groups 不为 None，则传递给此类初始化器的 cv 参数必须支持其 split 方法的 'groups' 参数。
cache_values (布尔值，默认值 False) – 是否缓存输入和第一阶段结果，这将允许重新拟合不同的最终模型
inference (字符串，Inference 实例，或 None) – 执行推断的方法。此估计器支持 ‘bootstrap’（或 :class:.BootstrapInference 的实例）和 ‘auto’（或 LinearModelFinalInference 的实例）

返回

self

返回类型

OrthoIV 实例

intercept__inference()

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

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

intercept__interval(*, alpha=0.05)

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

参数: alpha ([0, 1] 范围内的浮点数，默认值 0.05) – 所报告区间的总体置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。
返回: lower, upper – 置信区间的下限和上限。
返回类型: tuple(type of intercept_(), type of 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 – 每个数量的置信区间的下限和上限。

返回类型

tuple(type of marginal_ate(T, X), type of 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(type of marginal_effect(T, X), type of marginal_effect(T, X) )

refit_final(*, inference='auto')[source]

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

为了成功执行此操作，必须使用 cache_values=True 调用 fit。此调用将仅重新拟合最终模型。此调用将使用任何改变最终阶段估计参数的当前设置。如果任何改变第一阶段干扰项估计的参数也已更改，则此调用将无效。您需要再次调用 fit 来更改第一阶段估计结果。

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

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

在新数据集上对已拟合的 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 解释对象作为值。如果在拟合时的输入数据也包含元数据（例如，是 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 是结果变量的数量。如果原始输入是向量而不是二维数组，则省略维度。对于二元处理，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。

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

property intercept_

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

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

property model_cate

获取已拟合的最终 CATE 模型。

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

property models_t_xw

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

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

property models_t_xwz

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

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

property models_y_xw

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

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

property models_z_xw

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

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

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

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

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

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

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