econml.dowhy.DoWhyWrapper

class econml.dowhy.DoWhyWrapper(cate_estimator)[source]

基础类: object

这是一个包装类,允许用户通过 EconML 调用 DoWhy 包中的其他方法。(例如,因果图、反驳检验等)

参数

cate_estimator (instance) – 我们目前支持的任何 CATE 估计器实例

__init__(cate_estimator)[source]

方法

__init__(cate_estimator)

fit(Y, T[, X, W, Z, outcome_names, ...])

通过 dowhy 包从数据估计反事实模型。

refit_final([inference])

refute_estimate(*, method_name, **kwargs)

反驳估计的因果效应。

fit(Y, T, X=None, W=None, Z=None, *, outcome_names=None, treatment_names=None, feature_names=None, confounder_names=None, instrument_names=None, graph=None, estimand_type='nonparametric-ate', proceed_when_unidentifiable=True, missing_nodes_as_confounders=False, control_value=0, treatment_value=1, target_units='ate', **kwargs)[source]

通过 dowhy 包从数据估计反事实模型。

参数
  • Y (vector of length n) – 长度为 n 的向量

  • T (vector of length n) – 长度为 n 的向量

  • X ((n, d_x) matrix, optional) – (n, d_x) 矩阵,可选

  • W ((n, d_w) matrix, optional) – (n, d_w) 矩阵,可选

  • Z ((n, d_z) matrix, optional) – (n, d_z) 矩阵,可选

  • outcome_names (list, optional) – 列表,可选

  • treatment_names (list, optional) – 列表,可选

  • feature_names (list, optional) – 列表,可选

  • confounder_names (list, optional) – 列表,可选

  • instrument_names (list, optional) – 列表,可选

  • graph (str, optional) – 包含 DAG 的 DOT 文件路径,或 DOT 格式的 DAG 规范字符串

  • estimand_type (str, optional) – 所请求的估计量类型(目前仅支持“nonparametric-ate”)。将来可能支持其他特定的参数化识别形式

  • proceed_when_unidentifiable (bool, default True) – bool,默认 True:是否应忽略潜在的未观察到的混杂因素来继续识别

  • missing_nodes_as_confounders (bool, default False) – bool,默认 False:数据框中未包含在因果图中的变量是否应自动作为混杂节点包含

  • control_value (scalar, default 0) – scalar,默认 0:对照组中的处理值,用于效应估计

  • treatment_value (scalar, default 1) – scalar,默认 1:处理组中的处理值,用于效应估计

  • target_units (str or obj, default “ate”) – str 或 obj,默认“ate”:应估计处理效应的单位。可以是以下三种类型之一

    1. 用于常见目标单位规范的字符串(即“ate”、“att”和“atc”),

    2. 可作为数据索引(pandas DataFrame)的 lambda 函数,

    3. 一个新的 DataFrame,包含 effect_modifiers 的值,且效应将仅针对此新数据估计

  • kwargs (dict, optional) – dict,可选:CATE 估计器 fit 方法的其他关键字参数

返回类型

self

refute_estimate(*, method_name, **kwargs)[source]

反驳估计的因果效应。

如果提供了 method_name,则使用提供的方法。将来,我们可能支持自动选择合适的反驳检验。支持以下反驳方法

  • 添加随机生成的混杂因素:“random_common_cause”

  • 添加与处理和结果都相关的混杂因素:“add_unobserved_common_cause”

  • 将处理替换为安慰剂(随机)变量):“placebo_treatment_refuter”

  • 移除数据的随机子集:“data_subset_refuter”

更多详情,请参阅文档 dowhy.causal_refuters

参数
  • method_name (str) – 反驳方法的名称

  • kwargs (dict, optional) – dict,可选:直接传递给反驳方法的附加参数。可以在此处指定一个随机种子以确保结果可复现(‘random_seed’ 参数)。有关方法特定参数,请查阅特定方法的文档。所有反驳方法都在 causal_refuters 子包中。

返回

RefuteResult

返回类型

RefuteResult 类的一个实例