econml.dml.LinearDML

class econml.dml.LinearDML(*, model_y='auto', model_t='auto', featurizer=None, treatment_featurizer=None, fit_cate_intercept=True, linear_first_stages='deprecated', discrete_outcome=False, discrete_treatment=False, categories='auto', cv=2, mc_iters=None, mc_agg='mean', random_state=None, allow_missing=False, enable_federation=False, use_ray=False, ray_remote_func_options=None)[source]

具有低维线性最终阶段的双重机器学习估计器，实现为 statsmodel 回归。

参数

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

如果为 'auto'，则模型将是线性模型和森林模型集合中的最佳拟合模型
- 否则，请参阅模型选择查看支持的选项范围；如果指定了单个模型，则在 discrete_outcome 为 True 时应为分类器，否则应为回归器
- model_t (估计器, 默认 'auto') – 确定如何将处理变量拟合到特征。
否则，请参阅模型选择查看支持的选项范围；如果指定了单个模型，则在 discrete_treatment 为 True 时应为分类器，否则应为回归器
- 否则，请参阅模型选择查看支持的选项范围；如果指定了单个模型，则在 discrete_outcome 为 True 时应为分类器，否则应为回归器
- featurizer (转换器, 可选) – 必须支持 fit_transform 和 transform。用于在最终 CATE 回归中创建复合特征。如果 X 为 None，则忽略。最终 CATE 将在 featurizer.fit_transform(X) 的输出上训练。如果 featurizer=None，则 CATE 在 X 上训练。
treatment_featurizer (转换器, 可选) – 必须支持 fit_transform 和 transform。用于在最终 CATE 回归中创建复合处理变量。最终 CATE 将在 featurizer.fit_transform(T) 的输出上训练。如果 featurizer=None，则 CATE 在 T 上训练。
fit_cate_intercept (bool, 默认 True) – 线性 CATE 模型是否应具有常数项。
discrete_outcome (bool, 默认 False) – 结果变量是否应视为二元变量
discrete_treatment (bool, 默认 False) – 处理变量值是否应视为分类变量，而不是连续变量
categories (‘auto’ 或 list, 默认 ‘auto’) – 编码离散处理变量时使用的类别（或 'auto' 表示使用唯一的排序值）。第一个类别将视为对照处理变量。
cv (int, 交叉验证生成器或可迭代对象, 默认 2) – 确定交叉验证分割策略。cv 的可能输入包括
None，使用默认的 3 折交叉验证，
- 整数，指定折叠数量。
- CV 分割器
- 可迭代对象，生成 (train, test) 分割作为索引数组。
- 对于整数/None 输入，如果处理变量是离散的，则使用 StratifiedKFold；否则，使用 KFold（两种情况下都包含随机打乱）。
除非使用可迭代对象，否则我们调用 split(X,T) 生成分割。

mc_iters (int, 可选) – 重新运行第一阶段模型的次数，以减少干扰项的方差。
mc_agg ({'mean', 'median'}, 默认 'mean') – 如何在 mc_iters 次蒙特卡洛交叉拟合迭代中聚合每个样本的干扰项值。
random_state (int, RandomState 实例, 或 None, 默认 None) – 如果是整数，random_state 是随机数生成器使用的种子；如果是 RandomState 实例，random_state 是随机数生成器；如果是 None，则随机数生成器是 RandomState 实例，由 np.random 使用。
allow_missing (bool) – 是否允许 W 中存在缺失值。如果为 True，则需要提供能够处理缺失值的 model_y, model_t。
enable_federation (bool, 默认 False) – 是否为最终模型启用联邦。这需要内存成本，因此仅当此模型将与其他模型聚合时才应启用。
use_ray (bool, 默认 False) – 是否使用 Ray 并行化交叉拟合步骤。如果为 True，则必须安装 Ray。
ray_remote_func_options (dict, 默认 None) – 使用 Ray 时传递给远程函数的选项。详见 https://docs.rayai.org.cn/en/latest/ray-core/api/doc/ray.remote.html
示例

一个使用默认模型和离散处理变量的简单示例

__init__(*, model_y='auto', model_t='auto', featurizer=None, treatment_featurizer=None, fit_cate_intercept=True, linear_first_stages='deprecated', discrete_outcome=False, discrete_treatment=False, categories='auto', cv=2, mc_iters=None, mc_agg='mean', random_state=None, allow_missing=False, enable_federation=False, use_ray=False, ray_remote_func_options=None)[source]

from econml.dml import LinearDML

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 = LinearDML(discrete_treatment=True)
est.fit(y, T, X=X, W=None)

>>> est.effect(X[:3])
array([0.49977..., 1.91668..., 0.70799...])
>>> est.effect_interval(X[:3])
(array([0.15122..., 1.40176..., 0.40954...]),
array([0.84831..., 2.43159..., 1.00644...]))
>>> est.coef_
array([ 0.48825...,  0.00105...,  0.00244...,  0.02217..., -0.08471...])
>>> est.coef__interval()
(array([ 0.30469..., -0.13904..., -0.12790..., -0.11514..., -0.22505... ]),
array([0.67180..., 0.14116..., 0.13278..., 0.15949..., 0.05562...]))
>>> est.intercept_
1.01247...
>>> est.intercept__interval()
(0.87480..., 1.15015...)

方法

__init__(*[, model_y, model_t, featurizer, ...])

`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, *[, X, W, sample_weight, ...])
从数据估计反事实模型，即估计函数 τ(·,·,·)，∂τ(·,·)。	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[, X, W, sample_weight])
在新数据集上对拟合的 CATE 模型进行评分。	如果 model_final 没有 score 方法，则会引发 `AttributeError`
`shap_values`(X, *[, feature_names, ...])	最终阶段模型 (const_marginal_effect) 的 Shap 值
`summary`([alpha, value, decimals, ...])	常数边际处理效应线性模型中系数和截距的摘要。

属性

`bias_part_of_coef`
`coef_`	`const_marginal_ate`([X])
`dowhy`	获取 `DoWhyWrapper` 实例，以使用 dowhy 包的其他功能。（例如，因果图、反驳检验等）
`featurizer`
`featurizer_`
`fit_cate_intercept_`
`intercept_`	`marginal_ate`(T[, X])
`model_cate`	获取拟合的最终 CATE 模型。
`model_final`
`model_final_`
`models_nuisance_`
`models_t`	获取 E[T \| X, W] 的拟合模型。
`models_y`	获取 E[Y \| X, W] 的拟合模型。
`nuisance_scores_t`
`nuisance_scores_y`
`original_featurizer`
`ortho_learner_model_final_`
`residuals_`	一个包含来自第一阶段估计的残差以及关联的 X 和 W 的元组 (y_res, T_res, X, W)。样本顺序不保证与输入顺序相同。
`rlearner_model_final_`
`transformer`

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

ate_inference([X, T0, T1])

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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

返回

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

返回类型

float 或 (d_y,) 数组

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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

返回

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

返回类型

object

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
T0 ((m, d_t) 矩阵或长度为 m 的向量, 默认 0) – 每个样本的基础处理变量值
T1 ((m, d_t) 矩阵或长度为 m 的向量, 默认 1) – 每个样本的目标处理变量值
alpha (float in [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)

cate_output_names([output_names])

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: feature_names (长度为 X.shape[1] 的 str 列表或 None) – 输入特征的名称。如果为 None 且 X 是一个 dataframe，则默认为 dataframe 的列名。
返回: 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)

cate_treatment_names([treatment_names])

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: output_names (长度为 Y.shape[1] 的 str 列表或 None) – 结果变量的名称。如果为 None 且传递给 fit 的 Y 是一个 dataframe，则默认为 dataframe 的列名。
返回: output_names – 返回输出名称。
返回类型: list of str

cate_treatment_names(treatment_names=None)

coef__inference

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: treatment_names (长度为 T.shape[1] 的 str 列表, 可选) – 处理变量的名称。如果为 None 且传递给 fit 的 T 是一个 dataframe，则默认为 dataframe 的列名。
返回: out_treatment_names – 返回（可能已扩展的）处理变量名称。
返回类型: list of str

coef__inference()

coef__interval(*[, alpha])

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

coef__interval(*, alpha=0.05)

const_marginal_ate([X])

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: alpha (float in [0, 1], 默认 0.05) – 报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 置信区间。
返回: lb, ub – 每个量的置信区间的下限和上限。
返回类型: tuple(type of coef_(), type of coef_())

const_marginal_ate(X=None)

const_marginal_ate_inference([X])

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: 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 时可用。

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: X ((m, d_x) 矩阵, 可选) – 每个样本的特征
返回: PopulationSummaryResults – 推断结果实例包含预测和预测标准误，并可按需计算置信区间、z 统计量和 p 值。它还可以输出这些推断结果的 dataframe 摘要。
返回类型: object

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha (float in [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)

const_marginal_effect_inference([X])

边际效应是在 m 个测试样本 X[i] 的特征向量条件下计算的。

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: 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 时可用。

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: X ((m, d_x) 矩阵, 可选) – 每个样本的特征
返回: InferenceResults – 推断结果实例包含预测和预测标准误，并可按需计算置信区间、z 统计量和 p 值。它还可以输出这些推断结果的 dataframe 摘要。
返回类型: object

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha (float in [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)

effect_inference([X, T0, T1])

效应是在 m 个测试样本 \(\{T0_i, T1_i, X_i\}\) 的特征向量条件下，在两个处理变量值之间计算的。

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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 时可用。

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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

返回

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

返回类型

object

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
T0 ((m, d_t) 矩阵或长度为 m 的向量, 默认 0) – 每个样本的基础处理变量值
T1 ((m, d_t) 矩阵或长度为 m 的向量, 默认 1) – 每个样本的目标处理变量值
alpha (float in [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, *, X=None, W=None, sample_weight=None, freq_weight=None, sample_var=None, groups=None, cache_values=False, inference='auto')[source]

intercept__inference

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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

返回类型

self

intercept__inference()

intercept__interval(*[, alpha])

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

intercept__interval(*, alpha=0.05)

marginal_ate(T[, X])

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: alpha (float in [0, 1], 默认 0.05) – 报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 置信区间。
返回: lower, upper – 置信区间的下限和上限。
返回类型: tuple(type of intercept_(), type of intercept_())

marginal_ate(T, X=None)

marginal_ate_inference(T[, X])

边际效应是围绕基础处理变量值计算的，并对 X 的总体进行平均。

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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 时可用。

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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

返回

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

返回类型

object

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

T ((m, d_t) 矩阵) – 每个样本的基础处理变量值
X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha (float in [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)

marginal_effect_inference(T[, X])

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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 时可用。

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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

返回

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

返回类型

object

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

T ((m, d_t) 矩阵) – 每个样本的基础处理变量值
X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha (float in [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')

score(Y, T[, X, W, sample_weight])

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。: inference (推断方法, 可选) – 表示推断方法的字符串或对象
返回: self – 此实例
返回类型: object

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

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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

返回

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

返回类型

float

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

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

返回

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

返回类型

Explanation 对象的嵌套字典

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

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

model_y (估计器, 默认 'auto') – 确定如何将结果拟合到特征。

alpha (float in [0, 1], 默认 0.05) – 报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 置信区间。
value (float, 默认 0) – 在零假设下您想测试的指标的平均值。
decimals (int, 默认 3) – 每列四舍五入到的小数位数。
feature_names (str 列表, 可选) – 输入特征的名称
treatment_names (str 列表, 可选) – 处理变量的名称
output_names (str 列表, 可选) – 输出变量的名称

返回

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

返回类型

Summary 实例

property coef_

const_marginal_ate([X])

返回: 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) 数组类对象

property dowhy

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

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

property intercept_

marginal_ate(T[, X])

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

property model_cate

获取拟合的最终 CATE 模型。

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

property models_t

获取 E[T | X, W] 的拟合模型。

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

property models_y

获取 E[Y | X, W] 的拟合模型。

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

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