econml.iv.dml.DMLIV

class econml.iv.dml.DMLIV(*, model_y_xw='auto', model_t_xw='auto', model_t_xwz='auto', model_final=StatsModelsLinearRegression(fit_intercept=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]

基类，用于参数化 DMLIV 估计器，以估计 CATE。它接受三个通用的机器学习模型作为干扰函数：1) model_y_xw 估计 \(\E[Y | X]\) 2) model_t_xw 估计 \(\E[T | X]\) 3) model_t_xwz 估计 \(\E[T | X, Z]\) 这些模型在训练集中的每个样本上以交叉拟合的方式进行估计。然后最小化平方损失函数

用于估计 CATE 的参数化 DMLIV 估计器的基类。它接受三个通用机器学习模型作为辅助函数：1) model_y_xw，用于估计 \(\E[Y | X]\) 2) model_t_xw，用于估计 \(\E[T | X]\) 3) model_t_xwz，用于估计 \(\E[T | X, Z]\) 这些模型在训练集的每个样本上以交叉拟合的方式进行估计。然后，它最小化平方损失

\[\sum_i (Y_i - \E[Y|X_i] - \theta(X) * (\E[T|X_i, Z_i] - \E[T|X_i]))^2\]

该损失函数由作为输入传递的 model_final 类最小化。

参数

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_final (估计器 (默认是 StatsModelsLinearRegression)) – 最终模型，在拟合时将 \((Y-\E[Y|X])\)、\((\E[T|X,Z]-\E[T|X])\) 和 X 作为输入，并支持产生 X 处 CATE 的 predict(X) 方法。
featurizer (转换器) – 用于在拟合最终模型时对原始特征进行特征化的转换器。必须实现 fit_transform 方法。
fit_cate_intercept (bool, 默认 True) – 线性 CATE 模型是否应包含常数项。
discrete_instrument (bool, 默认 False) – 工具变量值是否应被视为分类量，而不是连续量。
discrete_outcome (bool, 默认 False) – 结果变量是否应被视为二元变量。
discrete_treatment (bool, 默认 False) – 处理变量值是否应被视为分类量，而不是连续量。
treatment_featurizer (转换器, 可选) – 必须支持 fit_transform 和 transform。用于在最终的 CATE 回归中创建复合处理。最终的 CATE 将在 featurizer.fit_transform(T) 的结果上进行训练。如果 featurizer=None，则 CATE 在 T 上进行训练。
categories ('auto' 或 list, 默认 'auto') – 对离散处理进行编码时使用的类别（或 'auto' 表示使用唯一的排序值）。第一个类别将被视为对照处理。
cv (int, 交叉验证生成器或可迭代对象, 默认 2) – 决定交叉验证的分割策略。cv 的可能输入包括：
- None，使用默认的 3 折交叉验证，
- 整数，指定折数。
- CV 分割器
- yielding (train, test) splits as arrays of indices.
对于整数/None 输入，如果处理变量是离散的，则使用 StratifiedKFold，否则使用 KFold（两种情况下都进行随机洗牌）。

除非使用可迭代对象，否则我们调用 split(concat[W, X], T) 来生成分割。如果 W, X 都为 None，则我们调用 split(ones((T.shape[0], 1)), T)。
random_state (int, RandomState 实例或 None, 默认 None) – 如果是 int，random_state 是随机数生成器使用的种子；如果是 RandomState 实例，random_state 是随机数生成器；如果是 None，随机数生成器是 RandomState 实例，由 np.random 使用。
mc_iters (int, 可选) – 重复运行第一阶段模型的次数，以减少干扰量的方差。
mc_agg ({'mean', 'median'}, 默认 'mean') – 如何聚合在 mc_iters 蒙特卡洛交叉拟合迭代中每个样本的干扰量值。
allow_missing (bool) – 是否允许 X, W 中存在缺失值。如果为 True，则需要提供能够处理缺失值的干扰模型和 model_final。

示例

使用默认模型的简单示例

from econml.iv.dml import DMLIV

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

>>> est.effect(X[:3])
array([-3.83383...,  5.31902..., -2.78082...])
>>> est.coef_
array([ 4.03889...,  0.89335...,  0.12043...,  0.37958..., -0.66097...])
>>> est.intercept_
-0.18482...

__init__(*, model_y_xw='auto', model_t_xw='auto', model_t_xwz='auto', model_final=StatsModelsLinearRegression(fit_intercept=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])	获取处理变量名称。
`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)\)。
`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 模型。根据拟合残差干扰模型（在拟合时创建）为新数据集生成干扰参数。它使用不同交叉拟合折叠拟合的模型的平均预测。然后计算最终残差 Y 对残差 T 回归的 MSE。
`shap_values`(X, *[, feature_names, ...])	最终阶段模型 (const_marginal_effect) 的 Shap 值
`summary`([decimals, feature_names, ...])	常数边际处理效应线性模型中系数和截距的概览。

属性

`bias_part_of_coef`
`coef_`	常数边际处理效应线性模型中的系数。
`dowhy`	获取 `DoWhyWrapper` 实例，以使用 dowhy 包中的其他功能。
`featurizer_`
`fit_cate_intercept_`
`intercept_`	常数边际处理效应线性模型中的截距。
`model_cate`	获取拟合的最终 CATE 模型。
`model_final_`
`models_nuisance_`
`models_t_xw`	获取 \(\E[T \| X]\) 的拟合模型。
`models_t_xwz`	获取 \(\E[T \| X, Z]\) 的拟合模型。
`models_y_xw`	获取 \(\E[Y \| X]\) 的拟合模型。
`nuisance_scores_t_xw`	获取在样本外训练数据上 t_xw 模型的得分
`nuisance_scores_t_xwz`	获取在样本外训练数据上 t_xwz 模型的得分
`nuisance_scores_y_xw`	获取在样本外训练数据上 y_xw 模型的得分
`original_featurizer`
`ortho_learner_model_final_`
`residuals_`	一个元组 (y_res, T_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 是向量而非二维数组时，结果将是一个标量

返回类型

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 值。它还可以输出这些推断结果的数据框概览。

返回类型

object

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)

获取输出特征名称。

参数: feature_names (长度为 X.shape[1] 的字符串列表或 None) – 输入特征的名称。如果为 None 且 X 是一个数据框，则默认为数据框的列名。
返回: out_feature_names – 输出特征 \(\phi(X)\) 的名称，即最终常数边际 CATE 模型对其呈线性的特征。它们是与 coef_() 参数的每个条目相关联的特征名称。当 featurizer 非 None 且不具有方法 get_feature_names(feature_names) 时不可用。否则返回 None。
返回类型: list of str or None

cate_output_names(output_names=None)

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

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

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

cate_treatment_names(treatment_names=None)

获取处理变量名称。

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

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

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 值。它还可以输出这些推断结果的数据框概览。
返回类型: object

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 – 对于每个样本 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 值。它还可以输出这些推断结果的数据框概览。
返回类型: object

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) matrix

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 值。它还可以输出这些推断结果的数据框概览。

返回类型

object

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=None)

从数据估计反事实模型，即估计函数 \(\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,) int array_like，可选的) – 观测值的权重。观测值 i 被视为 freq_weight[i] 个独立观测值的平均结果。当 sample_var 非 None 时，应提供此参数。
sample_var ({(n,), (n, d_y)} ndarray_like，可选的) – 对应于观测值 i 所代表的、用于计算平均结果的原始 freq_weight[i] 个观测值的结果的方差。
groups ((n,) 向量，可选的) – 属于同一组的所有行在分割时将被放在一起。如果 groups 非 None，传递给此类初始化器的 cv 参数必须支持其 split 方法的 ‘groups’ 参数。
cache_values (布尔值，默认为 False) – 是否缓存输入和第一阶段结果，这将允许重新拟合不同的最终模型。
inference (str, Inference 实例，或 None) – 执行推断的方法。此估计器支持 ‘bootstrap’（或 BootstrapInference 的实例）。

返回类型

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 值。它还可以输出这些推断结果的数据框概览。

返回类型

object

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 值。它还可以输出这些推断结果的数据框概览。

返回类型

object

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=None)

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

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

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

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

在新数据集上评估拟合的 CATE 模型。基于在 fit 时创建的拟合残差干扰项模型，为新数据集生成干扰项。它使用不同交叉拟合折叠拟合的模型的平均预测。然后计算最终残差 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,) vector, 可选) – 每个样本的权重

返回

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

返回类型

浮点数

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

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

参数

X ((m, d_x) matrix) – 每个样本的特征。应与最终阶段拟合的 X 形状相同。
feature_names (list of str of length 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 解释对象作为值。如果在拟合时输入数据也包含元数据（例如，是 pandas DataFrames），则使用处理变量、结果变量和特征的列元数据代替上述默认值（除非用户明确传递相应的名称进行覆盖）。

返回类型

嵌套字典，包含 Explanation 对象

summary(decimals=3, feature_names=None, treatment_names=None, output_names=None)[source]

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

参数

decimals (int, 默认 3) – 每列四舍五入到的小数位数。
feature_names (list of str, 可选) – 输入特征的名称
treatment_names (list of str, 可选) – 处理变量的名称
output_names (list of str, 可选) – 结果变量的名称

返回

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

返回类型

Summary 实例

property coef_

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

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

property dowhy

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

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

property intercept_

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

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

property model_cate

获取拟合的最终 CATE 模型。

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

property models_t_xw

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

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

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_t_xw: 获取在样本外训练数据上 t_xw 模型的得分

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

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

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