Skip to content

Commit 78b00ca

Browse files
igerberclaude
andcommitted
docs: drop draft-pdf CI workflow; scope survey-composition claims (review round 2)
- Remove .github/workflows/draft-pdf.yml: a durable CI job for the paper is overkill (user call). It served its purpose as a one-time compile check - the PDF built successfully and was visually verified; JOSS's editorialbot compiles the paper on demand during review. - paper.md: survey variance no longer claimed to compose with "every estimator" / "uniformly" - now states per-estimator support documented in a compatibility matrix with unsupported combinations failing closed - llms.txt / llms-full.txt / choosing_estimator.rst: "All estimators" -> "Most estimators" with SyntheticControl called out and a pointer to the Survey Design Support matrix (aligns with existing README wording) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent c793a56 commit 78b00ca

5 files changed

Lines changed: 11 additions & 44 deletions

File tree

.github/workflows/draft-pdf.yml

Lines changed: 0 additions & 36 deletions
This file was deleted.

diff_diff/guides/llms-full.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2075,7 +2075,7 @@ clear_cache()
20752075

20762076
## Survey Support
20772077

2078-
All estimators accept an optional `survey_design` parameter in `fit()`. Pass a `SurveyDesign` object to get design-based variance estimation.
2078+
Most estimators accept an optional `survey_design` parameter in `fit()` (`SyntheticControl` rejects it as not yet supported); depth of support varies by estimator - see the compatibility matrix in `docs/choosing_estimator.rst` (Survey Design Support). Pass a `SurveyDesign` object to get design-based variance estimation.
20792079

20802080
```python
20812081
from diff_diff import SurveyDesign, CallawaySantAnna

diff_diff/guides/llms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Full practitioner guide: call `diff_diff.get_llm_guide("practitioner")`
104104

105105
## Survey Support
106106

107-
All estimators accept an optional `survey_design` parameter. Pass a `SurveyDesign` object to get design-based variance estimation:
107+
Most estimators accept an optional `survey_design` parameter (`SyntheticControl` does not yet support it); coverage and weight types vary by estimator - see the [Survey Design Support matrix](https://diff-diff.readthedocs.io/en/stable/choosing_estimator.html#survey-design-support). Pass a `SurveyDesign` object to get design-based variance estimation:
108108

109109
- **Design elements**: strata, PSU, FPC, weight types (pweight/fweight/aweight), lonely PSU handling, nest
110110
- **Variance methods**: Taylor Series Linearization (TSL), replicate weights (BRR/Fay/JK1/JKn/SDR), survey-aware bootstrap

docs/choosing_estimator.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -771,10 +771,10 @@ If you're unsure which estimator to use:
771771
Survey Design Support
772772
---------------------
773773

774-
All estimators accept an optional ``survey_design`` parameter in ``fit()``
775-
(``SyntheticControl`` does not yet support it and raises ``NotImplementedError``).
774+
Most estimators support an optional ``survey_design`` parameter in ``fit()``
775+
(``SyntheticControl`` accepts the parameter but raises ``NotImplementedError``).
776776
Pass a :class:`~diff_diff.SurveyDesign` object to get design-based variance
777-
estimation. The depth of support varies by estimator:
777+
estimation. The depth of support varies by estimator and variance method:
778778

779779
.. note::
780780

paper.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ staggered-adoption support. General-purpose causal inference toolkits such as `D
7171
`diff-diff` was built as a new library, rather than as contributions to these packages,
7272
because its central contribution is cross-cutting: one estimator contract, one shared
7373
inference core, and an influence-function architecture that composes design-based survey
74-
variance with every estimator in the taxonomy. To our knowledge, no existing DiD software
74+
variance across the estimator taxonomy, with per-estimator support documented in a
75+
compatibility matrix and unsupported combinations failing closed. To our knowledge, no existing DiD software
7576
in any language provides design-based variance estimation for complex survey data, and no
7677
Python package covers the modern estimator taxonomy end-to-end; `diff-diff` provides
7778
both, validated against the R reference implementations where they exist.
@@ -130,8 +131,10 @@ is not identified, rather than silently reporting partial results.
130131
Two design choices carry the survey capability and the deployment story. First, estimators
131132
compute influence functions for their target parameters, so design-based variance - Taylor
132133
series linearization over strata and clusters, replicate weights, survey-aware
133-
bootstrap - composes uniformly with estimators as different as Callaway-Sant'Anna and
134-
synthetic DiD instead of requiring per-estimator derivations. Second, the runtime
134+
bootstrap - composes through one shared mechanism with estimators as different as
135+
Callaway-Sant'Anna and synthetic DiD; supported design-estimator combinations are
136+
documented in a per-estimator matrix, and unsupported ones are rejected explicitly rather
137+
than silently approximated. Second, the runtime
135138
dependency footprint is minimal by policy - numpy, pandas, and scipy only - keeping the
136139
library easy to install in restricted industry environments; high-dimensional fixed
137140
effects are handled by within-transformation rather than by delegating to a heavier

0 commit comments

Comments
 (0)