econml.inference.PopulationSummaryResults

class econml.inference.PopulationSummaryResults(pred, pred_stderr, mean_pred_stderr, d_t, d_y, alpha=0.05, value=0, decimals=3, tol=0.001, output_names=None, treatment_names=None)[source]

总群概括结果类,用于推断。

参数

d_t (int or None) – 处理数量
  • d_y (int) – 输出数量

  • pred (array_like, shape (m, d_y, d_t) or (m, d_y)) – 每个样本 X[i] 的度量预测。请注意,当 Y 或 T 是向量而不是二维数组时,相应的单例维度应被折叠(例如,如果两者都是向量,则此参数的输入也将是向量)

  • pred_stderr (array_like, shape (m, d_y, d_t) or (m, d_y)) – 每个样本 X[i] 的度量预测标准误差。请注意,当 Y 或 T 是向量而不是二维数组时,相应的单例维度应被折叠(例如,如果两者都是向量,则此参数的输入也将是向量)

  • mean_pred_stderr (None or array_like or scalar, shape (d_y, d_t) or (d_y,)) – 平均点估计的标准误差,这在最终阶段是线性模型时从系数标准误差推导出来,否则为 None。这是精确的平均标准误差,而不是保守的。

  • alpha (ffloat 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) – 处理名称列表

  • __init__(pred, pred_stderr, mean_pred_stderr, d_t, d_y, alpha=0.05, value=0, decimals=3, tol=0.001, output_names=None, treatment_names=None)[source]

方法

__init__(pred, pred_stderr, ...[, alpha, ...])

conf_int_mean(*[, alpha])

获取样本 X 上每个处理对每个结果的平均点估计的置信区间。

conf_int_point(*[, alpha, tol])

获取样本 X 上每个处理对每个结果的点估计的置信区间。

percentile_point(*[, alpha])

pvalue(*[, value])

percentile_point(*[, alpha])

获取样本 X 上每个处理对每个结果的 z 检验的 p 值。

summary([alpha, value, decimals, tol, ...])

输出上述概括推断。

zstat(*[, value])

获取样本 X 上每个处理对每个结果的平均点估计的 z 统计量。

属性

mean_point

获取样本 X 上每个处理对每个结果的点估计的平均值。

std_point

获取样本 X 上每个处理对每个结果的点估计的标准差。

stderr_mean

获取样本 X 上每个处理对每个结果的平均点估计的标准误差。

stderr_point

获取样本 X 上每个处理对每个结果的点估计的标准误差。

conf_int_mean(*, alpha=None)[source]

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

conf_int_point(*[, alpha, tol])

d_t (int or None) – 处理数量

返回值

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

返回类型

tuple of array, shape (d_y, d_t)

conf_int_point(*, alpha=None, tol=None)[source]

tol (optinal float) – 停止准则。当结果小于 tol 时,迭代将停止

percentile_point(*[, alpha])

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

返回类型

tuple of array, shape (d_y, d_t)

conf_int_point(*, alpha=None, tol=None)[source]

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

percentile_point(*[, alpha])

d_t (int or None) – 处理数量

pvalue(*, value=None)[source]

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

返回类型

tuple of array, shape (d_y, d_t)

conf_int_point(*, alpha=None, tol=None)[source]

value (float, optional) – 您希望在零假设下测试的度量的平均值。

summary([alpha, value, decimals, tol, ...])

d_t (int or None) – 处理数量

pvalue – 样本 X 上每个处理对每个结果的 z 检验的 p 值。请注意,当 Y 或 T 是向量而不是二维数组时,输出中相应的单例维度将折叠(例如,如果两者都是向量,则此方法的输出将是标量)

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

array_like, shape (d_y, d_t)

tuple of array, shape (d_y, d_t)

summary(alpha=None, value=None, decimals=None, tol=None, output_names=None, treatment_names=None)[source]

decimals (int, optional) – 每列要四舍五入的小数位数。

zstat(*[, value])

d_t (int or None) – 处理数量
  • 返回值

  • pvalue – 样本 X 上每个处理对每个结果的 z 检验的 p 值。请注意,当 Y 或 T 是向量而不是二维数组时,输出中相应的单例维度将折叠(例如,如果两者都是向量,则此方法的输出将是标量)

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

  • smry – 这包含概括表格和文本,可以打印或转换为各种输出格式。

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

  • __init__(pred, pred_stderr, mean_pred_stderr, d_t, d_y, alpha=0.05, value=0, decimals=3, tol=0.001, output_names=None, treatment_names=None)[source]

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

Summary instance

tuple of array, shape (d_y, d_t)

zstat(*, value=None)[source]

zstat – 样本 X 上每个处理对每个结果的平均点估计的 z 统计量。请注意,当 Y 或 T 是向量而不是二维数组时,输出中相应的单例维度将折叠(例如,如果两者都是向量,则此方法的输出将是标量)

属性

d_t (int or None) – 处理数量

pvalue – 样本 X 上每个处理对每个结果的 z 检验的 p 值。请注意,当 Y 或 T 是向量而不是二维数组时,输出中相应的单例维度将折叠(例如,如果两者都是向量,则此方法的输出将是标量)

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

property mean_point

tuple of array, shape (d_y, d_t)

summary(alpha=None, value=None, decimals=None, tol=None, output_names=None, treatment_names=None)[source]

mean_point – 样本 X 上每个处理对每个结果的点估计。请注意,当 Y 或 T 是向量而不是二维数组时,输出中相应的单例维度将折叠(例如,如果两者都是向量,则此方法的输出将是标量)

std_point

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

property std_point

tuple of array, shape (d_y, d_t)

summary(alpha=None, value=None, decimals=None, tol=None, output_names=None, treatment_names=None)[source]

std_point – 样本 X 上每个处理对每个结果的点估计的标准差。请注意,当 Y 或 T 是向量而不是二维数组时,输出中相应的单例维度将折叠(例如,如果两者都是向量,则此方法的输出将是标量)

stderr_mean

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

property stderr_mean

tuple of array, shape (d_y, d_t)

summary(alpha=None, value=None, decimals=None, tol=None, output_names=None, treatment_names=None)[source]

获取样本 X 上每个处理对每个结果的平均点估计的标准误差。输出是保守的上限。

stderr_mean – 样本 X 上每个处理对每个结果的平均点估计的标准误差。请注意,当 Y 或 T 是向量而不是二维数组时,输出中相应的单例维度将折叠(例如,如果两者都是向量,则此方法的输出将是标量)

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

property stderr_point

tuple of array, shape (d_y, d_t)

summary(alpha=None, value=None, decimals=None, tol=None, output_names=None, treatment_names=None)[source]

stderr_point – 样本 X 上每个处理对每个结果的点估计的标准误差。请注意,当 Y 或 T 是向量而不是二维数组时,输出中相应的单例维度将折叠(例如,如果两者都是向量,则此方法的输出将是标量)

conf_int_mean(*, alpha=None)[source]

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

tuple of array, shape (d_y, d_t)

summary(alpha=None, value=None, decimals=None, tol=None, output_names=None, treatment_names=None)[source]