DonorPoolQualityResult#

class causalpy.experiments.sc_results.DonorPoolQualityResult[source]#

Result of a donor pool quality assessment.

Produced by SyntheticControl.donor_pool_quality().

correlation_score#

Mean pairwise correlation between treated and control units.

Type:

float

convex_hull_coverage#

Fraction of pre-period time points where treated is within the donor envelope.

Type:

float

weight_concentration#

Effective number of donors (1 / sum(w_i^2)), measuring how concentrated the Dirichlet weights are.

Type:

float

per_donor_details#

Per-donor statistics: correlation, mean weight, etc.

Type:

pd.DataFrame

Methods

DonorPoolQualityResult.__init__(...)

DonorPoolQualityResult.summary()

Formatted summary with per-metric scores and qualitative assessment.

Attributes

correlation_score

convex_hull_coverage

weight_concentration

per_donor_details

__init__(correlation_score, convex_hull_coverage, weight_concentration, per_donor_details)#
Parameters:
Return type:

None

classmethod __new__(*args, **kwargs)#