econml.dml.SparseLinearDML

class econml.dml.SparseLinearDML(*, model_y='auto', model_t='auto', alpha='auto', n_alphas=100, alpha_cov='auto', n_alphas_cov=10, max_iter=1000, tol=0.0001, n_jobs=None, 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.DebiasedLassoCateEstimatorMixin, econml.dml.dml.DML

双重机器学习估计器 (Double ML estimator) 针对稀疏线性情况的专门版本。

当异质性特征是高维的，且线性 CATE 函数的系数是稀疏时，应使用此估计器。

最后阶段是 MultiOutputDebiasedLasso 的一个实例。

参数

model_y (估计器, 默认 'auto') – 决定如何将结果与特征进行拟合。
- 如果为 'auto'，模型将从一组线性和森林模型中选择最佳拟合模型。
- 否则，请参阅模型选择以了解支持的选项范围；如果指定了单一模型，当 discrete_outcome 为 True 时应为分类器，否则为回归器。
model_t (估计器, 默认 'auto') – 决定如何将处理与特征进行拟合。
- 如果为 'auto'，模型将从一组线性和森林模型中选择最佳拟合模型。
- 否则，请参阅模型选择以了解支持的选项范围；如果指定了单一模型，当 discrete_treatment 为 True 时应为分类器，否则为回归器。
alpha (str 或 float, 默认 ‘auto’) – 在最终模型中通过去偏 Lasso 应用的 CATE L1 正则化。‘auto’ 对应于 MultiOutputDebiasedLasso 的交叉验证形式。
n_alphas (int, 默认 100) – 如果 alpha=’auto’，要尝试多少个 alpha 值。
alpha_cov (str | float, 默认 ‘auto’) – 在构建用于校正去偏 Lasso 最终阶段 Lasso 系数的协方差矩阵 Theta 的伪逆时使用的正则化 alpha。每个这样的回归对应于一个特征对其余特征的回归。
n_alphas_cov (int, 默认 10) – 如果 alpha_cov=’auto’，要尝试多少个 alpha_cov 值。
max_iter (int, 默认 1000) – 去偏 Lasso 中的最大迭代次数。
tol (float, 默认 1e-4) – 优化的容差：如果更新小于 tol，优化代码会检查对偶间隙的最优性，并继续直到其小于 tol。
n_jobs (int 或 None, 可选) – 用于并行运行 fit 和 predict 的作业数。None 表示 1，除非在 joblib.parallel_backend() 上下文中。-1 表示使用所有处理器。
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 分割器
- 一个可迭代对象，以索引数组的形式生成 (训练集, 测试集) 分割。
对于整数/None 输入，如果处理是离散的，则使用 StratifiedKFold，否则使用 KFold（两种情况都会进行随机混洗）。

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

示例

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

from econml.dml import SparseLinearDML

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

>>> est.effect(X[:3])
array([0.50083..., 1.91663..., 0.70386...])
>>> est.effect_interval(X[:3])
(array([0.14616..., 1.40364..., 0.40674...]),
array([0.85550...  , 2.42962... , 1.00099...]))
>>> est.coef_
array([ 0.49123...,  0.00495...,  0.00007...,  0.02302..., -0.08483...])
>>> est.coef__interval()
(array([ 0.31323..., -0.13848..., -0.13721..., -0.11141..., -0.22961...]),
array([0.66923..., 0.14839... , 0.13735..., 0.15745..., 0.05993...]))
>>> est.intercept_
1.01476...
>>> est.intercept__interval()
(0.87620..., 1.15332...)

__init__(*, model_y='auto', model_t='auto', alpha='auto', n_alphas=100, alpha_cov='auto', n_alphas_cov=10, max_iter=1000, tol=0.0001, n_jobs=None, 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, alpha, ...])
`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, groups, ...])	从数据中估计反事实模型，即估计函数 τ(·,·,·), ∂τ(·,·)。
`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`
`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 值。它还可以输出这些推断结果的数据框摘要。

返回类型

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] 范围内的 float, 默认 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] 的 str 列表或 None) – 输入特征的名称。如果为 None 且 X 是数据框，则默认为数据框中的列名。
返回值: 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 是数据框，则默认为数据框中的列名。
返回值: output_names – 返回输出名称。
返回类型: str 列表

cate_treatment_names(treatment_names=None)

获取处理名称。

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

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

coef__inference()

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

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

coef__interval(*, alpha=0.05)

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

参数: alpha ([0, 1] 范围内的 float, 默认 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 值。它还可以输出这些推断结果的数据框摘要。
返回类型: object

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

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

参数

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha ([0, 1] 范围内的 float, 默认 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 值。它还可以输出这些推断结果的数据框摘要。
返回类型: object

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

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

参数

X ((m, d_x) 矩阵, 可选) – 每个样本的特征
alpha ([0, 1] 范围内的 float, 默认 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 值。它还可以输出这些推断结果的数据框摘要。

返回类型

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] 范围内的 float, 默认 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, 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) – 每个样本的个体权重。如果为 None，则假定权重相等。
groups ((n,) 向量, 可选) – 属于同一组的所有行将在分割时保持在一起。如果 groups 不为 None，传递给此类初始化器的 cv 参数必须支持其 split 方法的 ‘groups’ 参数。
cache_values (bool, 默认 False) – 是否缓存输入和第一阶段结果，这将允许重新拟合不同的最终模型。
inference (str, Inference 实例, 或 None) – 执行推断的方法。此估计器支持 ‘bootstrap’（或 BootstrapInference 的实例）和 ‘debiasedlasso’（或 LinearModelFinalInference 的实例）。

返回类型

self

intercept__inference()

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

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

intercept__interval(*, alpha=0.05)

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

参数: alpha ([0, 1] 范围内的 float, 默认 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 值。它还可以输出这些推断结果的数据框摘要。

返回类型

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] 范围内的 float, 默认 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] 范围内的 float, 默认 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')

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

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

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

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,) 向量，可选) – 每个样本的权重

返回值

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 (int，默认为 100) – 用于计算基准效应的样本数量。如果为 None，则使用所有样本。

返回值

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

返回类型

Explanation 对象的嵌套字典

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

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

参数

alpha ([0, 1] 范围内的 float, 默认 0.05) – 报告区间的总置信水平。报告的是 alpha/2, 1-alpha/2 置信区间。
value (浮点数，默认为 0) – 在零假设下，您希望检验的指标的平均值。
decimals (int，默认为 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) 类数组

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 模型。
返回类型: 类型为 type(model_final) 的对象

property models_t

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

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

property models_y

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

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

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