-
Notifications
You must be signed in to change notification settings - Fork 49
Expand file tree
/
Copy pathefficient_did_covariates.py
More file actions
962 lines (787 loc) · 34.1 KB
/
Copy pathefficient_did_covariates.py
File metadata and controls
962 lines (787 loc) · 34.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
"""
Doubly robust math for the Efficient DiD estimator (with covariates).
Implements the with-covariates path from Chen, Sant'Anna & Xie (2025):
OLS outcome regression (linear working model), sieve-based propensity
score ratios (Eq 4.1-4.2), sieve-based inverse propensities (step 4),
kernel-smoothed conditional Omega*(X) for per-unit efficient weights,
doubly robust generated outcomes (Eq 4.4), and the efficient influence
function for analytical standard errors.
The DR property ensures consistency if either the OLS outcome model or
the sieve propensity ratio is correctly specified. The OLS working model
does not generically guarantee the semiparametric efficiency bound unless
the conditional mean is linear in covariates (see REGISTRY.md).
All functions are pure (no state), operating on pre-pivoted numpy arrays.
"""
import warnings
from itertools import combinations_with_replacement
from math import comb
from typing import Dict, List, Optional, Tuple
import numpy as np
from scipy.spatial.distance import cdist
from diff_diff.linalg import solve_ols
# ---------------------------------------------------------------------------
# Outcome regression
# ---------------------------------------------------------------------------
def estimate_outcome_regression(
outcome_wide: np.ndarray,
covariate_matrix: np.ndarray,
group_mask: np.ndarray,
t_col: int,
tpre_col: int,
unit_weights: Optional[np.ndarray] = None,
) -> np.ndarray:
"""Estimate conditional mean outcome change m_hat(X) for a comparison group.
Regresses ``(Y_t - Y_{tpre})`` on ``X`` within the units identified by
``group_mask`` using OLS. Returns predicted values ``m_hat(X_i)`` for
**all** units (extrapolated from the within-group fit).
This implements ``m_hat_{g',t,tpre}(X) = E[Y_t - Y_{tpre} | G=g', X]``.
Parameters
----------
outcome_wide : ndarray, shape (n_units, n_periods)
Pivoted outcome matrix.
covariate_matrix : ndarray, shape (n_units, n_covariates)
Unit-level (time-invariant) covariates.
group_mask : ndarray of bool, shape (n_units,)
Mask selecting units in the comparison group.
t_col, tpre_col : int
Column indices in ``outcome_wide`` for the two time periods.
unit_weights : ndarray, shape (n_units,), optional
Survey weights at the unit level. When provided, uses WLS
instead of OLS for the within-group regression.
Returns
-------
m_hat : ndarray, shape (n_units,)
Predicted ``E[Y_t - Y_{tpre} | X]`` for every unit.
"""
Y_group = outcome_wide[group_mask]
delta_y = Y_group[:, t_col] - Y_group[:, tpre_col]
X_group = covariate_matrix[group_mask]
X_design = np.column_stack([np.ones(len(X_group)), X_group])
w_group = unit_weights[group_mask] if unit_weights is not None else None
coef, _, _ = solve_ols(
X_design,
delta_y,
weights=w_group,
weight_type="pweight" if w_group is not None else None,
return_vcov=False,
rank_deficient_action="warn",
)
X_all = np.column_stack([np.ones(len(covariate_matrix)), covariate_matrix])
coef_safe = np.where(np.isfinite(coef), coef, 0.0)
m_hat = X_all @ coef_safe
non_finite = ~np.isfinite(m_hat)
if non_finite.any():
n_bad = int(non_finite.sum())
warnings.warn(
f"Outcome regression produced {n_bad} non-finite prediction(s). "
"Setting to 0.0 (equivalent to no covariate adjustment).",
UserWarning,
stacklevel=2,
)
m_hat[non_finite] = 0.0
return m_hat
# ---------------------------------------------------------------------------
# Sieve-based propensity ratio estimation (Eq 4.1-4.2)
# ---------------------------------------------------------------------------
def _polynomial_sieve_basis(X: np.ndarray, degree: int) -> np.ndarray:
"""Build polynomial sieve basis up to total degree K.
For d covariates and degree K, includes all monomials
``X_1^{a_1} * ... * X_d^{a_d}`` where ``a_1 + ... + a_d <= K``,
including the intercept term (degree 0).
Standardizes X to zero mean, unit variance for numerical stability.
Parameters
----------
X : ndarray, shape (n, d)
Covariate matrix.
degree : int
Maximum total polynomial degree.
Returns
-------
basis : ndarray, shape (n, n_basis)
Sieve basis matrix. ``n_basis = C(K+d, d)``.
"""
n, d = X.shape
# Standardize for numerical stability (unweighted mean/std intentional —
# this is only for conditioning, not for the statistical estimand; with
# survey weights the sieve basis is the same, only the objective changes)
X_mean = X.mean(axis=0)
X_std = X.std(axis=0)
X_std[X_std < 1e-10] = 1.0 # avoid division by zero for constant columns
X_s = (X - X_mean) / X_std
# Build monomials: enumerate all (a_1, ..., a_d) with sum <= degree
columns = [np.ones(n)] # degree-0 (intercept)
for total_deg in range(1, degree + 1):
for exponents in combinations_with_replacement(range(d), total_deg):
col = np.ones(n)
for idx in exponents:
col = col * X_s[:, idx]
columns.append(col)
return np.column_stack(columns)
def estimate_propensity_ratio_sieve(
covariate_matrix: np.ndarray,
mask_g: np.ndarray,
mask_gp: np.ndarray,
k_max: Optional[int] = None,
criterion: str = "bic",
ratio_clip: float = 20.0,
unit_weights: Optional[np.ndarray] = None,
) -> np.ndarray:
r"""Estimate propensity ratio via sieve convex minimization (Eq 4.1-4.2).
Solves for each sieve degree K = 1, ..., k_max:
.. math::
\hat\beta_K = \arg\min_{\beta} \frac{1}{n}
\sum_i \bigl[ G_{g',i} (\psi^K(X_i)'\beta)^2
- 2 G_{g,i} (\psi^K(X_i)'\beta) \bigr]
The FOC gives a closed-form linear system (no iterative optimization):
``(Psi_{g'}' Psi_{g'}) beta = Psi_g.sum(axis=0)``.
Selects K via AIC/BIC: ``IC(K) = 2*loss(K) + C_n*K/n``.
Precondition check per K: if ``cond(Psi_{g'}' W Psi_{g'}) > 1/sqrt(eps)``
(≈ 6.7e7), that K is skipped. LinAlgError on the `np.linalg.solve` call
or a non-finite beta skips as well. If at least one K succeeds but
others were skipped, emits a ``UserWarning`` listing the skipped K
values (silent-failure audit PR, axis-A finding #18). If every K is
skipped, the caller falls back to a constant ratio of 1 with a
separate "estimation failed for all K values" warning.
Short-circuits ``r_{g,g}(X) = 1`` for same-cohort comparisons (PT-All).
Parameters
----------
covariate_matrix : ndarray, shape (n_units, n_covariates)
mask_g : ndarray of bool, shape (n_units,)
Target treatment group mask.
mask_gp : ndarray of bool, shape (n_units,)
Comparison group mask.
k_max : int or None
Maximum polynomial degree. None = ``min(floor(n_gp^{1/5}), 5)``.
criterion : str
``"aic"`` or ``"bic"``.
ratio_clip : float
Clip ratios to ``[1/ratio_clip, ratio_clip]``.
unit_weights : ndarray, shape (n_units,), optional
Survey weights at the unit level. When provided, uses weighted
normal equations for the sieve estimation.
Returns
-------
ratio : ndarray, shape (n_units,)
Estimated ``r_{g,g'}(X_i)`` for every unit.
"""
n_units = len(covariate_matrix)
n_gp = int(np.sum(mask_gp))
# Short-circuit: r_{g,g}(X) = 1 for same-cohort comparisons (PT-All)
if np.array_equal(mask_g, mask_gp):
return np.ones(n_units)
d = covariate_matrix.shape[1]
# Default k_max: use comparison group size, not total n
if k_max is None:
k_max = min(int(n_gp**0.2), 5)
k_max = max(k_max, 1)
# Penalty multiplier for IC
# BIC penalty uses observation count (not weighted) — complexity vs distinct obs
n_total = int(np.sum(mask_g)) + n_gp
c_n = 2.0 if criterion == "aic" else np.log(max(n_total, 2))
# Weighted totals for loss normalization (raw probability weights)
if unit_weights is not None:
w_g = unit_weights[mask_g]
w_gp = unit_weights[mask_gp]
n_total_w = float(np.sum(w_g)) + float(np.sum(w_gp))
else:
w_g = None
w_gp = None
n_total_w = float(n_total)
best_ic = np.inf
best_ratio = np.ones(n_units) # fallback: constant ratio 1
singular_K: List[int] = [] # K values skipped due to rank deficiency (#18)
# Near-singular matrices solve without raising LinAlgError but return
# numerically meaningless beta. Rule-of-thumb threshold: 1/sqrt(eps).
cond_threshold = 1.0 / np.sqrt(np.finfo(float).eps)
for K in range(1, k_max + 1):
n_basis = comb(K + d, d)
# Cap K so basis dimension < n_gp (avoid singular system)
if n_basis >= n_gp:
break
basis_all = _polynomial_sieve_basis(covariate_matrix, K)
Psi_gp = basis_all[mask_gp] # (n_gp, n_basis)
Psi_g = basis_all[mask_g] # (n_g, n_basis)
# Normal equations (weighted when survey weights present):
# Unweighted: (Psi_gp' Psi_gp) beta = Psi_g.sum(axis=0)
# Weighted: (Psi_gp' W_gp Psi_gp) beta = (w_g * Psi_g).sum(axis=0)
if w_gp is not None:
A = Psi_gp.T @ (w_gp[:, None] * Psi_gp)
b = (w_g[:, None] * Psi_g).sum(axis=0)
else:
A = Psi_gp.T @ Psi_gp
b = Psi_g.sum(axis=0)
# Precondition check (#18, axis A): reject near-singular A explicitly
# so np.linalg.solve can't silently return garbage coefficients.
with np.errstate(invalid="ignore", over="ignore"):
A_cond = float(np.linalg.cond(A))
if not np.isfinite(A_cond) or A_cond > cond_threshold:
singular_K.append(K)
continue
try:
beta = np.linalg.solve(A, b)
except np.linalg.LinAlgError:
singular_K.append(K)
continue # singular — try next K
# Check for NaN/Inf in solution
if not np.all(np.isfinite(beta)):
singular_K.append(K)
continue
# Predicted ratio for all units
r_hat = basis_all @ beta
# IC selection: loss at optimum = -(1/n_w) * b'beta
# Derivation: L(beta) = (1/n_w)(beta'A*beta - 2*b'beta).
# At optimum A*beta = b, so beta'A*beta = b'beta.
# Therefore L = (1/n_w)(b'beta - 2*b'beta) = -(1/n_w)*b'beta.
# Loss uses weighted totals; BIC penalty uses observation count.
loss = -float(b @ beta) / n_total_w
ic_val = 2.0 * loss + c_n * n_basis / n_total
if ic_val < best_ic:
best_ic = ic_val
best_ratio = r_hat.copy()
# Warn if no sieve fit succeeded (falling back to constant ratio 1)
if best_ic == np.inf:
warnings.warn(
"Propensity ratio sieve estimation failed for all K values. "
"Falling back to constant ratio of 1 (no ratio adjustment). "
"The DR estimator relies on outcome regression only.",
UserWarning,
stacklevel=2,
)
elif singular_K:
# Finding #18 (axis A): partial K-failure was previously silent.
# Surface it so users see that the selected basis order was
# forced by rank deficiency at higher K rather than by the IC.
warnings.warn(
f"Propensity ratio sieve: skipped K={singular_K} due to "
f"rank-deficient or non-finite normal equations. "
f"Selected basis used the remaining K values; "
f"this may indicate limited variation in the covariates.",
UserWarning,
stacklevel=2,
)
# Overlap diagnostics: warn if ratios require significant clipping
n_extreme = int(np.sum((best_ratio < 1.0 / ratio_clip) | (best_ratio > ratio_clip)))
if n_extreme > 0:
pct = 100.0 * n_extreme / n_units
warnings.warn(
f"Sieve propensity ratios for {n_extreme} of {n_units} units "
f"({pct:.1f}%) were outside [{1.0/ratio_clip:.2f}, {ratio_clip:.1f}] "
f"and will be clipped. This may indicate overlap assumption "
f"violations (near-zero propensity scores for some covariate values).",
UserWarning,
stacklevel=2,
)
# Clip: population ratio p_g(X)/p_{g'}(X) is non-negative
best_ratio = np.clip(best_ratio, 1.0 / ratio_clip, ratio_clip)
return best_ratio
# ---------------------------------------------------------------------------
# Sieve-based inverse propensity estimation (Algorithm step 4)
# ---------------------------------------------------------------------------
def estimate_inverse_propensity_sieve(
covariate_matrix: np.ndarray,
group_mask: np.ndarray,
k_max: Optional[int] = None,
criterion: str = "bic",
unit_weights: Optional[np.ndarray] = None,
) -> np.ndarray:
r"""Estimate s_{g'}(X) = 1/p_{g'}(X) via sieve convex minimization.
Solves for each sieve degree K:
.. math::
\hat\beta_K = \arg\min_\beta \frac{1}{n}
\sum_i \bigl[ G_{g',i} (\psi^K(X_i)'\beta)^2
- 2 (\psi^K(X_i)'\beta) \bigr]
FOC: ``(Psi_{g'}' Psi_{g'}) beta = Psi_all.sum(axis=0)``
This is the same structure as the ratio estimator but with all
units on the RHS (not just group g), following the paper's
algorithm step 4.
Precondition check per K: if ``cond(Psi_{g'}' W Psi_{g'}) > 1/sqrt(eps)``
(≈ 6.7e7), that K is skipped. LinAlgError on the `np.linalg.solve` call
or a non-finite beta skips as well. If at least one K succeeds but
others were skipped, emits a ``UserWarning`` listing the skipped K
values (silent-failure audit PR, axis-A finding #18). If every K is
skipped, the caller falls back to unconditional ``n/n_group`` scaling
with a separate "estimation failed for all K values" warning.
Parameters
----------
covariate_matrix : ndarray, shape (n_units, n_covariates)
group_mask : ndarray of bool, shape (n_units,)
Mask for the group whose inverse propensity to estimate.
k_max : int or None
Maximum polynomial degree. None = auto.
criterion : str
``"aic"`` or ``"bic"``.
unit_weights : ndarray, shape (n_units,), optional
Survey weights at the unit level. When provided, uses weighted
normal equations for the sieve estimation.
Returns
-------
s_hat : ndarray, shape (n_units,)
Estimated ``1/p_{g'}(X_i)`` for every unit. Clipped to [1, n].
"""
n_units = len(covariate_matrix)
n_group = int(np.sum(group_mask))
d = covariate_matrix.shape[1]
if n_group == 0:
return np.ones(n_units)
if k_max is None:
k_max = min(int(n_group**0.2), 5)
k_max = max(k_max, 1)
# BIC penalty uses observation count (not weighted)
c_n = 2.0 if criterion == "aic" else np.log(max(n_units, 2))
# Weighted loss normalization and fallback
if unit_weights is not None:
w_group = unit_weights[group_mask]
sum_w_group = float(np.sum(w_group))
if sum_w_group <= 0:
# Zero survey weight for this group — return unconditional fallback
return np.ones(n_units)
n_units_w = float(np.sum(unit_weights))
fallback_ratio = n_units_w / sum_w_group
else:
w_group = None
n_units_w = float(n_units)
fallback_ratio = n_units / n_group
best_ic = np.inf
best_s = np.full(n_units, fallback_ratio) # fallback: unconditional
singular_K: List[int] = [] # K values skipped due to rank deficiency (#18)
cond_threshold = 1.0 / np.sqrt(np.finfo(float).eps)
for K in range(1, k_max + 1):
n_basis = comb(K + d, d)
if n_basis >= n_group:
break
basis_all = _polynomial_sieve_basis(covariate_matrix, K)
Psi_gp = basis_all[group_mask]
# Normal equations (weighted when survey weights present):
# Unweighted: (Psi_gp' Psi_gp) beta = Psi_all.sum(axis=0)
# Weighted: (Psi_gp' W_group Psi_gp) beta = (w_all * Psi_all).sum(axis=0)
if w_group is not None:
A = Psi_gp.T @ (w_group[:, None] * Psi_gp)
b = (unit_weights[:, None] * basis_all).sum(axis=0)
else:
A = Psi_gp.T @ Psi_gp
# RHS: sum of basis over ALL units (not just one group)
b = basis_all.sum(axis=0)
# Precondition check (#18, axis A): see ratio-sieve comment above.
with np.errstate(invalid="ignore", over="ignore"):
A_cond = float(np.linalg.cond(A))
if not np.isfinite(A_cond) or A_cond > cond_threshold:
singular_K.append(K)
continue
try:
beta = np.linalg.solve(A, b)
except np.linalg.LinAlgError:
singular_K.append(K)
continue
if not np.all(np.isfinite(beta)):
singular_K.append(K)
continue
s_hat = basis_all @ beta
# IC: loss = -(1/n_w) * b'beta (same derivation as ratio estimator)
# Loss uses weighted totals; BIC penalty uses observation count.
loss = -float(b @ beta) / n_units_w
ic_val = 2.0 * loss + c_n * n_basis / n_units
if ic_val < best_ic:
best_ic = ic_val
best_s = s_hat.copy()
# Warn if no sieve fit succeeded (falling back to unconditional)
if best_ic == np.inf:
warnings.warn(
"Inverse propensity sieve estimation failed for all K values. "
"Falling back to unconditional n/n_group scaling.",
UserWarning,
stacklevel=2,
)
elif singular_K:
# Finding #18 (axis A): partial K-failure was previously silent.
warnings.warn(
f"Inverse propensity sieve: skipped K={singular_K} due to "
f"rank-deficient or non-finite normal equations. "
f"Selected basis used the remaining K values; "
f"this may indicate limited variation in the covariates.",
UserWarning,
stacklevel=2,
)
# Overlap diagnostics: warn if s_hat values require clipping
n_clipped = int(np.sum((best_s < 1.0) | (best_s > float(n_units))))
if n_clipped > 0:
pct = 100.0 * n_clipped / n_units
warnings.warn(
f"Inverse propensity estimates for {n_clipped} of {n_units} units "
f"({pct:.1f}%) were outside [1, {n_units}] and will be clipped. "
f"This may indicate overlap assumption violations.",
UserWarning,
stacklevel=2,
)
# s = 1/p must be >= 1 (since p <= 1) and bounded above
best_s = np.clip(best_s, 1.0, float(n_units))
return best_s
# ---------------------------------------------------------------------------
# Doubly robust generated outcomes (Eq 4.4)
# ---------------------------------------------------------------------------
def compute_generated_outcomes_cov(
target_g: float,
target_t: float,
valid_pairs: List[Tuple[float, float]],
outcome_wide: np.ndarray,
cohort_masks: Dict[float, np.ndarray],
never_treated_mask: np.ndarray,
period_to_col: Dict[float, int],
period_1_col: int,
cohort_fractions: Dict[float, float],
m_hat_cache: Dict[Tuple, np.ndarray],
r_hat_cache: Dict[Tuple[float, float], np.ndarray],
never_treated_val: float = np.inf,
) -> np.ndarray:
"""Compute per-unit doubly robust generated outcomes (Eq 4.4).
For each valid pair ``(g', t_pre)`` and each unit ``i``, three terms::
Term 1 (treated):
(G_{g,i} / pi_g) * (Y_{i,t} - Y_{i,1}
- m_{inf,t,tpre}(X_i) - m_{g',tpre,1}(X_i))
Term 2 (never-treated):
-r_{g,inf}(X_i) * (G_{inf,i} / pi_g)
* (Y_{i,t} - Y_{i,tpre} - m_{inf,t,tpre}(X_i))
Term 3 (comparison cohort):
-r_{g,g'}(X_i) * (G_{g',i} / pi_g)
* (Y_{i,tpre} - Y_{i,1} - m_{g',tpre,1}(X_i))
Returns
-------
gen_out : ndarray, shape (n_units, H)
Per-unit generated outcome for each valid pair.
"""
H = len(valid_pairs)
n_units = outcome_wide.shape[0]
if H == 0:
return np.empty((n_units, 0))
t_col = period_to_col[target_t]
y1_col = period_1_col
g_mask = cohort_masks[target_g]
pi_g = cohort_fractions[target_g]
# Guard: zero survey weight for the target cohort → no DR estimation possible
if pi_g <= 0:
return np.zeros((n_units, H))
gen_out = np.zeros((n_units, H))
for j, (gp, tpre) in enumerate(valid_pairs):
tpre_col = period_to_col[tpre]
m_inf_t_tpre = m_hat_cache[(never_treated_val, t_col, tpre_col)]
m_gp_tpre_1 = m_hat_cache[(gp, tpre_col, y1_col)]
r_g_inf = r_hat_cache[(target_g, never_treated_val)]
r_g_gp = r_hat_cache[(target_g, gp)]
# Term 1: treated units
if pi_g > 0:
Y_t_minus_Y1 = outcome_wide[g_mask, t_col] - outcome_wide[g_mask, y1_col]
residual_treated = Y_t_minus_Y1 - m_inf_t_tpre[g_mask] - m_gp_tpre_1[g_mask]
gen_out[g_mask, j] += (1.0 / pi_g) * residual_treated
# Term 2: never-treated units
pi_inf = cohort_fractions.get(never_treated_val, 0.0)
if pi_inf > 0:
Y_t_minus_Ytpre = (
outcome_wide[never_treated_mask, t_col] - outcome_wide[never_treated_mask, tpre_col]
)
residual_inf = Y_t_minus_Ytpre - m_inf_t_tpre[never_treated_mask]
gen_out[never_treated_mask, j] -= (
r_g_inf[never_treated_mask] * (1.0 / pi_g) * residual_inf
)
# Term 3: comparison cohort units
if np.isinf(gp):
gp_mask = never_treated_mask
else:
gp_mask = cohort_masks[gp]
pi_gp = cohort_fractions.get(gp, 0.0)
if pi_gp > 0:
Y_tpre_minus_Y1 = outcome_wide[gp_mask, tpre_col] - outcome_wide[gp_mask, y1_col]
residual_gp = Y_tpre_minus_Y1 - m_gp_tpre_1[gp_mask]
gen_out[gp_mask, j] -= r_g_gp[gp_mask] * (1.0 / pi_g) * residual_gp
return gen_out
# ---------------------------------------------------------------------------
# Kernel-smoothed conditional Omega* (Eq 3.12)
# ---------------------------------------------------------------------------
def _silverman_bandwidth(X: np.ndarray) -> float:
"""Silverman's rule-of-thumb bandwidth for d-dimensional X.
``h = (4 / (d + 2))^{1/(d+4)} * median_std * n^{-1/(d+4)}``
"""
n, d = X.shape
stds = np.std(X, axis=0)
stds[stds < 1e-10] = 1.0
median_std = float(np.median(stds))
h = (4.0 / (d + 2)) ** (1.0 / (d + 4)) * median_std * n ** (-1.0 / (d + 4))
return max(h, 1e-10)
def _kernel_weights_matrix(
X_all: np.ndarray,
X_group: np.ndarray,
bandwidth: float,
group_weights: Optional[np.ndarray] = None,
) -> np.ndarray:
"""Gaussian kernel weight matrix.
Returns shape ``(n_all, n_group)`` where entry ``[i, j]`` is the
normalized kernel weight ``K_h(X_group[j], X_all[i])``.
Each row sums to 1 (Nadaraya-Watson normalization).
Parameters
----------
group_weights : ndarray, shape (n_group,), optional
Survey weights for the group units. When provided, kernel
weights are multiplied by survey weights before row-normalization,
making the Nadaraya-Watson estimator survey-weighted.
"""
# Squared distances: (n_all, n_group)
dist_sq = cdist(X_all, X_group, metric="sqeuclidean")
# Gaussian kernel
raw = np.exp(-dist_sq / (2.0 * bandwidth**2))
# Survey-weight: each group unit j contributes ∝ w_j * K_h(X_i, X_j)
if group_weights is not None:
raw = raw * group_weights[np.newaxis, :]
# Normalize each row
row_sums = raw.sum(axis=1, keepdims=True)
row_sums[row_sums < 1e-15] = 1.0 # avoid division by zero
return raw / row_sums
def _kernel_weighted_cov(
A: np.ndarray,
B: np.ndarray,
W: np.ndarray,
) -> np.ndarray:
"""Kernel-weighted local covariance.
Parameters
----------
A : ndarray, shape (n_group,)
B : ndarray, shape (n_group,)
W : ndarray, shape (n_all, n_group)
Normalized kernel weights (rows sum to 1).
Returns
-------
cov : ndarray, shape (n_all,)
``Cov_hat(A, B | X_i)`` for each target unit i.
"""
# Local means: (n_all,)
A_local = W @ A
B_local = W @ B
# Centered products: (n_all, n_group)
A_centered = A[np.newaxis, :] - A_local[:, np.newaxis] # (n_all, n_group)
B_centered = B[np.newaxis, :] - B_local[:, np.newaxis]
# Weighted local covariance: (n_all,)
cov = np.sum(W * A_centered * B_centered, axis=1)
return cov
def compute_omega_star_conditional(
target_g: float,
target_t: float,
valid_pairs: List[Tuple[float, float]],
outcome_wide: np.ndarray,
cohort_masks: Dict[float, np.ndarray],
never_treated_mask: np.ndarray,
period_to_col: Dict[float, int],
period_1_col: int,
cohort_fractions: Dict[float, float],
covariate_matrix: np.ndarray,
s_hat_cache: Dict[float, np.ndarray],
bandwidth: Optional[float] = None,
unit_weights: Optional[np.ndarray] = None,
never_treated_val: float = np.inf,
) -> np.ndarray:
r"""Kernel-smoothed conditional Omega\*(X_i) for each unit (Eq 3.12).
Estimates the five-term conditional covariance matrix using
Nadaraya-Watson kernel regression with Gaussian kernel and
local (kernel-weighted) means. Scales each term by per-unit
conditional inverse propensities ``s_hat_g(X_i) = 1/p_g(X_i)``
(algorithm step 4), matching the paper's Eq 3.12.
Parameters
----------
target_g, target_t : float
Target group-time.
valid_pairs : list of (g', t_pre)
outcome_wide : ndarray, shape (n_units, n_periods)
cohort_masks, never_treated_mask, period_to_col, period_1_col,
cohort_fractions : pre-computed data structures
covariate_matrix : ndarray, shape (n_units, n_covariates)
s_hat_cache : dict
Inverse propensity estimates ``{group: s_hat(X_i)}`` where each
value is shape ``(n_units,)``. Keyed by group identifier.
bandwidth : float or None
Kernel bandwidth. None = Silverman's rule.
unit_weights : ndarray, shape (n_units,), optional
Survey weights at the unit level. When provided, kernel-smoothed
covariances use survey-weighted Nadaraya-Watson regression.
never_treated_val : float
Returns
-------
omega : ndarray, shape (n_units, H, H)
Per-unit conditional covariance matrices.
"""
H = len(valid_pairs)
n_units = outcome_wide.shape[0]
if H == 0:
return np.empty((n_units, 0, 0))
if bandwidth is None:
bandwidth = _silverman_bandwidth(covariate_matrix)
t_col = period_to_col[target_t]
y1_col = period_1_col
g_mask = cohort_masks[target_g]
Y_inf = outcome_wide[never_treated_mask]
X_inf = covariate_matrix[never_treated_mask]
# Per-unit inverse propensities from sieve estimation (Eq 3.12)
s_g = s_hat_cache.get(target_g, np.full(n_units, 1.0 / max(cohort_fractions[target_g], 1e-10)))
s_inf = s_hat_cache.get(
never_treated_val,
np.full(n_units, 1.0 / max(cohort_fractions.get(never_treated_val, 1e-10), 1e-10)),
)
# Scalability warning
if n_units > 5000:
warnings.warn(
f"Conditional Omega* estimation with n={n_units} is expensive "
f"(O(n^2 * H^2)). Consider using fewer units.",
UserWarning,
stacklevel=2,
)
# Per-group survey weights for kernel smoothing
w_g = unit_weights[g_mask] if unit_weights is not None else None
w_inf = unit_weights[never_treated_mask] if unit_weights is not None else None
# Pre-compute kernel weight matrices per group
Y_g = outcome_wide[g_mask]
X_g = covariate_matrix[g_mask]
Yg_t_minus_1 = Y_g[:, t_col] - Y_g[:, y1_col]
W_g = _kernel_weights_matrix(covariate_matrix, X_g, bandwidth, group_weights=w_g)
W_inf = _kernel_weights_matrix(covariate_matrix, X_inf, bandwidth, group_weights=w_inf)
inf_t_minus_tpre = {}
for _, tpre in valid_pairs:
tpre_col = period_to_col[tpre]
if tpre_col not in inf_t_minus_tpre:
inf_t_minus_tpre[tpre_col] = Y_inf[:, t_col] - Y_inf[:, tpre_col]
W_gp_cache: Dict[float, np.ndarray] = {}
gp_outcomes_cache: Dict[float, np.ndarray] = {}
omega = np.zeros((n_units, H, H))
# Term 1: s_g(X) * Cov(Y_t-Y_1, Y_t-Y_1 | G=g, X) — same for all (j,k)
term1 = s_g * _kernel_weighted_cov(Yg_t_minus_1, Yg_t_minus_1, W_g)
for j in range(H):
gp_j, tpre_j = valid_pairs[j]
tpre_j_col = period_to_col[tpre_j]
for k in range(j, H):
gp_k, tpre_k = valid_pairs[k]
tpre_k_col = period_to_col[tpre_k]
val = term1.copy()
# Term 2: s_inf(X) * Cov(Y_t-Y_{tpre_j}, Y_t-Y_{tpre_k} | G=inf, X)
val += s_inf * _kernel_weighted_cov(
inf_t_minus_tpre[tpre_j_col],
inf_t_minus_tpre[tpre_k_col],
W_inf,
)
# Term 3: -1{g==g'_j} * s_g(X) * Cov(Y_t-Y_1, Y_{tpre_j}-Y_1 | G=g, X)
if gp_j == target_g:
g_tpre_j = Y_g[:, tpre_j_col] - Y_g[:, y1_col]
val -= s_g * _kernel_weighted_cov(Yg_t_minus_1, g_tpre_j, W_g)
# Term 4: -1{g==g'_k} * s_g(X) * Cov(Y_t-Y_1, Y_{tpre_k}-Y_1 | G=g, X)
if gp_k == target_g:
g_tpre_k = Y_g[:, tpre_k_col] - Y_g[:, y1_col]
val -= s_g * _kernel_weighted_cov(Yg_t_minus_1, g_tpre_k, W_g)
# Term 5: 1{g'_j==g'_k} * s_{g'_j}(X) * Cov(...)
if gp_j == gp_k:
if np.isinf(gp_j):
inf_tpre_j = Y_inf[:, tpre_j_col] - Y_inf[:, y1_col]
inf_tpre_k = Y_inf[:, tpre_k_col] - Y_inf[:, y1_col]
val += s_inf * _kernel_weighted_cov(inf_tpre_j, inf_tpre_k, W_inf)
else:
s_gp_j = s_hat_cache.get(
gp_j, np.full(n_units, 1.0 / max(cohort_fractions.get(gp_j, 1e-10), 1e-10))
)
if gp_j not in W_gp_cache:
X_gp = covariate_matrix[cohort_masks[gp_j]]
w_gp_j = unit_weights[cohort_masks[gp_j]] if unit_weights is not None else None
W_gp_cache[gp_j] = _kernel_weights_matrix(
covariate_matrix, X_gp, bandwidth, group_weights=w_gp_j
)
gp_outcomes_cache[gp_j] = outcome_wide[cohort_masks[gp_j]]
W_gp = W_gp_cache[gp_j]
Y_gp = gp_outcomes_cache[gp_j]
gp_tpre_j = Y_gp[:, tpre_j_col] - Y_gp[:, y1_col]
gp_tpre_k = Y_gp[:, tpre_k_col] - Y_gp[:, y1_col]
val += s_gp_j * _kernel_weighted_cov(gp_tpre_j, gp_tpre_k, W_gp)
omega[:, j, k] = val
if j != k:
omega[:, k, j] = val
return omega
# ---------------------------------------------------------------------------
# Per-unit efficient weights from conditional Omega*
# ---------------------------------------------------------------------------
def compute_per_unit_weights(
omega_conditional: np.ndarray,
cond_threshold: float = 1e12,
) -> np.ndarray:
"""Per-unit efficient weights from conditional Omega* inverse.
``w(X_i) = 1' Omega*(X_i)^{-1} / (1' Omega*(X_i)^{-1} 1)``
Falls back to pseudoinverse per unit if condition number exceeds threshold.
Parameters
----------
omega_conditional : ndarray, shape (n_units, H, H)
Per-unit conditional covariance matrices.
cond_threshold : float
Condition number threshold for pseudoinverse fallback.
Returns
-------
weights : ndarray, shape (n_units, H)
Per-unit efficient combination weights (each row sums to 1).
"""
n_units, H, _ = omega_conditional.shape
if H == 0:
return np.empty((n_units, 0))
if H == 1:
return np.ones((n_units, 1))
ones = np.ones(H)
weights = np.zeros((n_units, H))
for i in range(n_units):
omega_i = omega_conditional[i]
if np.allclose(omega_i, 0.0):
weights[i] = ones / H
continue
cond = float(np.linalg.cond(omega_i))
if cond > cond_threshold:
omega_inv = np.linalg.pinv(omega_i)
else:
try:
omega_inv = np.linalg.inv(omega_i)
except np.linalg.LinAlgError:
omega_inv = np.linalg.pinv(omega_i)
numerator = ones @ omega_inv
denominator = numerator @ ones
if abs(denominator) < 1e-15:
weights[i] = ones / H
else:
weights[i] = numerator / denominator
return weights
# ---------------------------------------------------------------------------
# EIF computation
# ---------------------------------------------------------------------------
def compute_eif_cov(
weights: np.ndarray,
generated_outcomes: np.ndarray,
att_gt: float,
n_units: int,
) -> np.ndarray:
"""Per-unit efficient influence function from DR generated outcomes.
Supports both global weights ``(H,)`` and per-unit weights ``(n_units, H)``.
For global weights: ``EIF_i = w @ (gen_out_i - y_bar) = w @ gen_out_i - ATT``
For per-unit weights: ``EIF_i = w(X_i) @ gen_out_i - ATT``
In both cases the EIF centers on the scalar ATT estimate, ensuring
``mean(EIF) ≈ 0``. The plug-in EIF treats estimated per-unit weights
as fixed, valid under Neyman orthogonality (Remark 4.2).
Parameters
----------
weights : ndarray, shape (H,) or (n_units, H)
Efficient combination weights.
generated_outcomes : ndarray, shape (n_units, H)
Per-unit generated outcomes.
att_gt : float
Scalar ATT estimate for this (g, t) cell.
n_units : int
Total number of units.
Returns
-------
eif : ndarray, shape (n_units,)
EIF value for every unit. Sample mean is approximately zero.
"""
if weights.size == 0:
return np.zeros(n_units)
if weights.ndim == 1:
# Global weights: w @ gen_out_i for each unit
weighted_scores = generated_outcomes @ weights # (n_units,)
else:
# Per-unit weights: w_i @ gen_out_i for each unit
weighted_scores = np.sum(weights * generated_outcomes, axis=1)
# Center on the scalar ATT estimate (ensures mean(EIF) ≈ 0)
eif = weighted_scores - att_gt
return eif