econml.dml.DML

class econml.dml.DML(*, model_y, model_t, model_final, 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, use_ray=False, ray_remote_func_options=None)[source]

基类: econml._cate_estimator.LinearModelFinalCateEstimatorMixin, econml.dml.dml._BaseDML

参数化双重 ML 估计器的基类。该估计器是 _RLearner 估计器的特例，后者又是 _OrthoLearner 估计器的特例，因此它遵循两阶段过程：第一阶段以交叉拟合方式估计一组干扰函数，最终阶段估计 CATE 模型。有关此两阶段过程的描述，请参阅 _OrthoLearner 的文档。

在此估计器中，CATE 使用以下估计方程进行估计

\[Y - \E[Y | X, W] = \Theta(X) \cdot (T - \E[T | X, W]) + \epsilon\]

因此，如果在第一阶段估计干扰函数 \(q(X, W) = \E[Y | X, W]\) 和 \(f(X, W)=\E[T | X, W]\)，则可以通过运行回归、最小化残差平方损失来估计每个处理 t 的最终阶段 cate：

\[\hat{\theta} = \arg\min_{\Theta} \E_n\left[ (\tilde{Y} - \Theta(X) \cdot \tilde{T})^2 \right]\]

其中 \(\tilde{Y}=Y - \E[Y | X, W]\) 和 \(\tilde{T}=T-\E[T | X, W]\) 表示残差结果和残差处理。

DML 估计器进一步假设 cate 具有线性参数形式，即对于每个结果 \(i\) 和处理 \(j\)

\[\Theta_{i, j}(X) = \phi(X)' \cdot \Theta_{ij}\]

对于某些给定的特征映射 \(\phi(X)\)（用户可以在初始化时通过 featurizer 参数提供此 featurizer，它可以是任何遵循 scikit-learn 转换器接口 TransformerMixin 的任意类）。

第二个干扰函数 \(q\) 是一个简单的回归问题，DML 类接受参数 model_y 作为输入，它是一个任意的 scikit-learn 回归器，内部用于解决此回归问题。

估计干扰函数 \(f\) 的问题也是一个回归问题，DML 类接受参数 model_t 作为输入，它是一个任意的 scikit-learn 回归器，内部用于解决此回归问题。如果初始化标志 discrete_treatment 设置为 True，则参数 model_t 将被视为 scikit-learn 分类器。输入的分类处理将被进行独热编码（排除按字典顺序最小的处理，该处理用作基线），并使用 model_t 分类器的 predict_proba 方法对独热编码的处理进行残差化。

最终阶段是（可能是多任务的）线性回归问题，其结果标签为 \(\tilde{Y}\)，回归器为组合特征 \(\tilde{T}\otimes \phi(X) = \mathtt{vec}(\tilde{T}\cdot \phi(X)^T)\)。DML 接受输入参数 model_final，它是内部用于解决此（多任务的）线性回归问题的任何线性 scikit-learn 回归器。

参数

model_y (估计器, 默认 'auto') – 决定如何将结果拟合到特征。
- 如果 'auto'，模型将是线性模型和森林模型集合中最适合的模型。
- 否则，请参阅模型选择以了解支持的选项范围；如果指定了单个模型，则在 discrete_outcome 为 True 时应为分类器，否则为回归器
model_t (估计器, 默认 'auto') – 决定如何将处理拟合到特征。
- 如果 'auto'，模型将是线性模型和森林模型集合中最适合的模型。
- 否则，请参阅模型选择以了解支持的选项范围；如果指定了单个模型，则在 discrete_treatment 为 True 时应为分类器，否则为回归器
model_final (估计器) – 用于将响应残差拟合到处理残差的估计器。必须实现 fit 和 predict 方法，并且为了正确性，必须是线性模型。
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’ 以使用唯一的排序值）。第一个类别将被视为对照处理。
verbose (int, 默认 2) – 输出消息的详细程度级别。值越高表示越详细。
cv (int, 交叉验证生成器或可迭代对象, 默认 2) – 决定交叉验证拆分策略。cv 可能的输入包括
- None，使用默认的 3 折交叉验证，
- 整数，指定折叠数。
- CV 拆分器
- 一个可迭代对象，生成 (训练, 测试) 拆分作为索引数组。
对于整数/None 输入，如果处理是离散的，则使用 StratifiedKFold，否则使用 KFold（两种情况下都有随机洗牌）。

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

示例

离散处理和一个线性 model_final 的简单示例（等同于 LinearDML）

from econml.dml import DML
from econml.sklearn_extensions.linear_model import StatsModelsLinearRegression
from sklearn.ensemble import RandomForestRegressor, RandomForestClassifier

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 = DML(
    model_y=RandomForestRegressor(),
    model_t=RandomForestClassifier(),
    model_final=StatsModelsLinearRegression(fit_intercept=False),
    discrete_treatment=True
)
est.fit(y, T, X=X, W=None)

>>> est.effect(X[:3])
array([0.63382..., 1.78225..., 0.71859...])
>>> est.effect_interval(X[:3])
(array([0.27937..., 1.27619..., 0.42091...]),
array([0.98827... , 2.28831..., 1.01628...]))
>>> est.coef_
array([ 0.42857...,  0.04488..., -0.03317...,  0.02258..., -0.14875...])
>>> est.coef__interval()
(array([ 0.25179..., -0.10558..., -0.16723... , -0.11916..., -0.28759...]),
array([ 0.60535...,  0.19536...,  0.10088...,  0.16434..., -0.00990...]))
>>> est.intercept_
1.01166...
>>> est.intercept__interval()
(0.87125..., 1.15207...)

__init__(*, model_y, model_t, model_final, 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, use_ray=False, ray_remote_func_options=None)[source]

方法

`__init__`(*, model_y, model_t, model_final[, ...])
`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 模型。
`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_`
`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_`	一个元组 (y_res, T_res, X, W)，包含第一阶段估计的残差以及相关的 X 和 W。
`rlearner_model_final_`
`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 或 (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 (float, 在 [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] 的 str 列表或 None) – 输入特征的名称。如果为 None 且 X 是一个 dataframe，则默认为该 dataframe 的列名。
返回: out_feature_names – 输出特征 \(\phi(X)\) 的名称，即最终常数边际 CATE 模型对其呈线性的特征。这些名称与 coef_() 参数的每个条目关联。当 featurizer 不为 None 且没有方法 get_feature_names(feature_names) 时不可用。否则返回 None。
返回类型: str 列表或 None

cate_output_names(output_names=None)

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

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

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

cate_treatment_names(treatment_names=None)

获取处理名称。

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

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

coef__inference()

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

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

coef__interval(*, alpha=0.05)

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

参数: alpha (float, 在 [0, 1] 范围内, 默认 0.05) – 报告区间的总置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。
返回: lb, ub – 每个量的置信区间的下界和上界。
返回类型: tuple(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 (float, 在 [0, 1] 范围内, 默认 0.05) – 报告区间的总置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。

返回

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

返回类型

tuple(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 (float, 在 [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 (float, 在 [0, 1] 范围内, 默认 0.05) – 报告区间的总置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。

返回

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

返回类型

tuple(effect(X, T0, T1) 的类型, 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]

从数据中估计反事实模型，即估计函数 τ(·,·,·), ∂τ(·,·)。

参数

Y ((n × d_y) 矩阵或长度为 n 的向量) – 每个样本的结果
T ((n × dₜ) 矩阵或长度为 n 的向量) – 每个样本的处理
X ((n × dₓ) 矩阵, 可选) – 每个样本的特征
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,) vector, 可选) – 对应于同一组的所有行将在拆分过程中保持在一起。如果 groups 不为 None，则传递给此类初始化器的 cv 参数必须支持其 split 方法的 ‘groups’ 参数。
cache_values (bool, 默认 False) – 是否缓存输入和第一阶段结果，这将允许重新拟合不同的最终模型
inference (str, Inference 实例, 或 None) – 执行推断的方法。此估计器支持 ‘bootstrap’（或 BootstrapInference 的实例）和 ‘auto’（或 LinearModelFinalInference 的实例）

返回类型

self

intercept__inference()

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

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

intercept__interval(*, alpha=0.05)

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

参数: alpha (float, 在 [0, 1] 范围内, 默认 0.05) – 报告区间的总置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。
返回: lower, upper – 置信区间的下界和上界。
返回类型: tuple(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 (float, 在 [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 (float, 在 [0, 1] 范围内, 默认 0.05) – 报告区间的总置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。

返回

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

返回类型

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

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

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

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

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

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

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

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

参数

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

返回

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

返回类型

float

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] 的 str 列表, 可选) – 输入特征的名称。
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 DataFrame），则使用处理、结果和特征的列元数据，而不是上述默认值（除非用户通过显式传递相应名称进行覆盖）。

返回类型

Explanation 对象的嵌套字典

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

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

参数

alpha (float, 在 [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_

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

返回: coef – 其中 n_x 是进入最终模型的特征数量（如果 CATE 估计器具有特征提取器，则为 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 的实例
返回类型: 实例

property intercept_

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

返回: 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_: 一个元组 (y_res, T_res, X, W)，包含第一阶段估计的残差以及相关的 X 和 W。不保证样本的顺序与输入顺序相同。