econml.inference.EmpiricalInferenceResults

class econml.inference.EmpiricalInferenceResults(d_t, d_y, pred, pred_dist, inf_type, fname_transformer=None, feature_names=None, output_names=None, treatment_names=None)

基类： econml.inference._inference.InferenceResults

使用经验样本集进行推断的结果类。

参数

• pred (array_like, shape (m, d_y, d_t) 或 (m, d_y)) – 使用完整样本得到的指标的点估计

• pred_dist (array_like, shape (b, m, d_y, d_t) 或 (b, m, d_y)) – 采样 b 次得到的指标的原始预测。注意，当 Y 或 T 是向量而不是二维数组时，相应的单例维度应折叠

• d_t (int or None) – 处理数

• d_y (int) – 输出数

• inf_type (str) – 推断结果的类型。可以是 'effect', 'coefficient' 或 'intercept'。

• fname_transformer (None 或 predefined function) – 从 featurizer 获取相应特征名称的转换函数

__init__(d_t, d_y, pred, pred_dist, inf_type, fname_transformer=None, feature_names=None, output_names=None, treatment_names=None)

方法

__init__(d_t, d_y, pred, pred_dist, inf_type)
conf_int([alpha])	获取每个样本 X[i] 的每个处理对每个结果的指标的置信区间。
population_summary([alpha, value, decimals, ...])	输出总体汇总结果的对象。
pvalue([value])	获取每个样本 X[i] 的每个处理对每个结果的 p 值。
scale(factor)	通过乘以一个因子来更新结果。
summary_frame([alpha, value, decimals, ...])	输出包含上述所有推断结果的 DataFrame。
translate(other)	通过加上一个偏移量来更新结果。
zstat([value])	获取每个样本 X[i] 的每个处理对每个结果的指标的 z 统计量。

属性

point_estimate	获取每个样本 X[i] 的每个处理对每个结果的点估计。
stderr	获取每个样本 X[i] 的每个处理对每个结果的指标的标准误差。
var	获取每个样本 X[i] 的每个处理对每个结果的指标的方差。

conf_int(alpha=0.05)

获取每个样本 X[i] 的每个处理对每个结果的指标的置信区间。

参数

alpha (float in [0, 1], default 0.05) – 所报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 的置信区间。

返回值

lower, upper – 每个数量的置信区间的下限和上限。注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是向量）

返回类型

tuple of array, shape (m, d_y, d_t) 或 (m, d_y)

population_summary(alpha=0.05, value=0, decimals=3, tol=0.001, output_names=None, treatment_names=None)

输出总体汇总结果的对象。

参数

• alpha (float in [0, 1], default 0.05) – 所报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 的置信区间。

• value (float, default 0) – 在原假设下您想测试的指标的平均值。

• decimals (int, default 3) – 每列四舍五入到的小数位数。

• tol (float, default 0.001) – 停止准则。当结果小于 tol 时停止迭代

• output_names (list of str, optional) – 输出的名称

• treatment_names (list of str, optional) – 处理的名称

返回值

PopulationSummaryResults – 总体汇总结果实例包含样本 X 上每个处理和结果的点估计的不同汇总分析。

返回类型

对象

pvalue(value=0)

获取每个样本 X[i] 的每个处理对每个结果的 p 值。

参数

value (float, default 0) – 在原假设下您想测试的指标的平均值。

返回值

pvalue – 每个样本 X[i] 的每个处理对每个结果的 p 值。注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是向量）

返回类型

array_like, shape (m, d_y, d_t) 或 (m, d_y)

scale(factor)

通过乘以一个因子来更新结果。

参数

factor (array_like) – 用于缩放这些结果的因子

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

输出包含上述所有推断结果的 DataFrame。

参数

• alpha (float in [0, 1], default 0.05) – 所报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 的置信区间。

• value (float, default 0) – 在原假设下您想测试的指标的平均值。

• decimals (int, default 3) – 每列四舍五入到的小数位数。

• feature_names (list of str, optional) – 特征 X 的名称

• output_names (list of str, optional) – 输出的名称

• treatment_names (list of str, optional) – 处理的名称

返回值

output – 输出 DataFrame 包括每个样本 X[i] 的每个处理对每个结果的估计指标的点估计、标准误差、z 分数、p 值和置信区间。

返回类型

DataFrame

translate(other)

通过加上一个偏移量来更新结果。

参数

offset (array_like) – 用于平移这些结果的偏移量

zstat(value=0)

获取每个样本 X[i] 的每个处理对每个结果的指标的 z 统计量。

参数

value (float, default 0) – 在原假设下您想测试的指标的平均值。

返回值

zstat – 每个样本 X[i] 的每个处理对每个结果的指标的 z 统计量。注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是向量）

返回类型

array_like, shape (m, d_y, d_t) 或 (m, d_y)

property point_estimate

获取每个样本 X[i] 的每个处理对每个结果的点估计。

返回值

prediction – 每个样本 X[i] 的每个处理对每个结果的点估计。注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是向量）

返回类型

array_like, shape (m, d_y, d_t) 或 (m, d_y)

property stderr

获取每个样本 X[i] 的每个处理对每个结果的指标的标准误差。

返回值

stderr – 每个样本 X[i] 的每个处理对每个结果的指标的标准误差。注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是向量）

返回类型

array_like, shape (m, d_y, d_t) 或 (m, d_y)

property var

获取每个样本 X[i] 的每个处理对每个结果的指标的方差。

返回值

var – 每个样本 X[i] 的每个处理对每个结果的指标的方差。注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是向量）

返回类型

array_like, shape (m, d_y, d_t) 或 (m, d_y)