econml.inference.NormalInferenceResults
- class econml.inference.NormalInferenceResults(d_t, d_y, pred, pred_stderr, mean_pred_stderr, inf_type, fname_transformer=None, feature_names=None, output_names=None, treatment_names=None)[源代码]
基类:
econml.inference._inference.InferenceResults假设正态分布的推断结果类。
- 参数
d_t (
int 或 None) – 处理的数量 d_y (
int) – 输出的数量 pred (
array_like, shape (m, d_y, d_t) 或 (m, d_y)) – 每个样本 X[i] 的度量的预测值。请注意，当 Y 或 T 是向量而不是二维数组时，相应的单例维度应被折叠（例如，如果两者都是向量，则此参数的输入也将是向量） pred_stderr (
array_like, shape (m, d_y, d_t) 或 (m, d_y)) – 每个样本 X[i] 的度量的预测标准误差。请注意，当 Y 或 T 是向量而不是二维数组时，相应的单例维度应被折叠（例如，如果两者都是向量，则此参数的输入也将是向量） mean_pred_stderr (
None 或 array_like 或 scaler, shape (d_y, d_t) 或 (d_y,)) – 平均点估计的标准误差，这在最终阶段是线性模型时从系数标准误差中导出，否则为 None。这是平均值的精确标准误差，不是保守的。 inf_type (
str) – 推断结果的类型。它可以是 'effect'、'coefficient' 或 'intercept'。 fname_transformer (
None 或 预定义函数) – 从 featurizer 获取相应特征名称的转换函数
- __init__(d_t, d_y, pred, pred_stderr, mean_pred_stderr, inf_type, fname_transformer=None, feature_names=None, output_names=None, treatment_names=None)[源代码]
方法
__init__(d_t, d_y, pred, pred_stderr, ...[, ...])conf_int([alpha])获取每个样本 X[i] 上每个处理对每个结果的度量的置信区间。
population_summary([alpha, value, decimals, ...])输出总体摘要结果对象。
pvalue([value])获取每个样本 X[i] 上每个处理对每个结果的 z 检验的 p 值。
scale(factor)通过缩放因子就地更新结果。
summary_frame([alpha, value, decimals, ...])输出包含上述所有推断的数据框。
translate(offset)通过平移偏移量就地更新结果。
zstat([value])获取每个样本 X[i] 上每个处理对每个结果的度量的 z 统计量。
属性
获取每个样本 X[i] 上每个处理对每个结果的点估计。
获取每个样本 X[i] 上每个处理对每个结果的度量的标准误差。
获取每个样本 X[i] 上每个处理对每个结果的度量的方差。
- conf_int(alpha=0.05)[源代码]
获取每个样本 X[i] 上每个处理对每个结果的度量的置信区间。
- 参数
alpha (
float 在 [0, 1] 范围内, 默认为 0.05) – 报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 置信区间。 - 返回
lower, upper – 每个数量的置信区间的下限和上限。请注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是向量）
- 返回类型
array 的 tuple, 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 在 [0, 1] 范围内, 默认为 0.05) – 报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 置信区间。 value (
float, 默认为 0) – 您希望在原假设下检验的度量的平均值。 decimals (
int, 默认为 3) – 每列四舍五入到的小数位数。 tol (
float, 默认为 0.001) – 停止准则。当结果小于 tol时，迭代将停止output_names (
list of str, 可选) – 输出的名称 treatment_names (
list of str, 可选) – 处理的名称
- 返回
PopulationSummaryResults – 总体摘要结果实例包含对样本 X 在每个处理和结果上的点估计的不同摘要分析。
- 返回类型
- pvalue(value=0)[源代码]
获取每个样本 X[i] 上每个处理对每个结果的 z 检验的 p 值。
- 参数
value (
float, 默认为 0) – 您希望在原假设下检验的度量的平均值。 - 返回
pvalue – 每个样本 X[i] 上每个处理对每个结果的 z 检验的 p 值。请注意，当 Y 或 T 是向量而不是二维数组时，输出中相应的单例维度将被折叠（例如，如果两者都是向量，则此方法的输出也将是向量）
- 返回类型
array_like, shape 为 (m, d_y, d_t) 或 (m, d_y)
- summary_frame(alpha=0.05, value=0, decimals=3, feature_names=None, output_names=None, treatment_names=None)
输出包含上述所有推断的数据框。
- 参数
alpha (
float 在 [0, 1] 范围内, 默认为 0.05) – 报告区间的总体置信水平。报告 alpha/2, 1-alpha/2 置信区间。 value (
float, 默认为 0) – 您希望在原假设下检验的度量的平均值。 decimals (
int, 默认为 3) – 每列四舍五入到的小数位数。 feature_names (
list of str, 可选) – 特征 X 的名称 output_names (
list of str, 可选) – 输出的名称 treatment_names (
list of str, 可选) – 处理的名称
- 返回
output – 输出数据框包括每个样本 X[i] 上每个处理对每个结果的估计度量的点估计、标准误差、z 分数、p 值和置信区间
- 返回类型
DataFrame
- translate(offset)
通过平移偏移量就地更新结果。
- 参数
offset (
array_like) – 用于平移这些结果的偏移量
- zstat(value=0)
获取每个样本 X[i] 上每个处理对每个结果的度量的 z 统计量。
- 参数
value (
float, 默认为 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)