Skip to content

Document the cd model on the package and the website (PR C of 4) - #4

Merged
cmg777 merged 3 commits into
mainfrom
docs/cd-model
Oct 16, 2026
Merged

cmg777 merged 3 commits into
mainfrom
docs/cd-model

Conversation

@cmg777

@cmg777 cmg777 commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Stacked on #3. It documents the cd model on the package and the website.

New pages

  • docs/models/cd.qmd, rewritten in the shape of the sar page:

    • setup;
    • the spillover model: Examples 1–3, custom structures, several treated units;
    • estimation, including the efficient estimator;
    • inference;
    • structure checks: κ_A, selection, sensitivity;
    • an accessor table;
    • where scspill departs from the authors' application code and from mlsynth.

    Citations are mapped to the paper's v3 sections.

  • Case study prop99-spillovers.qmd (executed and frozen, with a Colab notebook notebooks/prop99_spillovers.ipynb):

    • cd on Cao & Dowd's 51-unit panel: the direct effect and Nevada's leakage;
    • the year-by-year joint "no spillover" test;
    • the κ_A test, which rejects the paper's 13-state structure after 1989 and is reported as a warning;
    • structure comparison, the sensitivity analysis, and the 41-unit specification;
    • a side-by-side comparison with sar, including why the two models disagree on the sign of Nevada's spillover.
  • Article articles/cd-replication.qmd (executed and frozen) reproduces, live:

    • v3's Section 6.2 statements: insignificant 1989–1990 effects, and Figure 3's break-even points 17.07 and 9.66;
    • the authors' frozen application output, with every P value equal;
    • their simulation statistics;
    • mlsynth.

Site and package updates

  • Navbar: "Sudan case study" becomes a "Case studies" menu with Prop 99 and Sudan; the Articles menu gains the replication article. sudan.html keeps its URL.
  • Pages: the model catalogue (with "Reach for it when / Look elsewhere when"), the landing page, Get started, the datasets article, For AI/LLMs, llms.txt, and the quartodoc section descriptions.
  • Package files: README, the CITATION.cff abstract, package docstrings, and the cao_dowd fixture README, which now cites v3 and describes its checks as checks against the authors' code.
  • Benchmarks: california_cd and cd_vs_mlsynth, registered in benchmarks/registry.py; both pass. The full REPORT.md is regenerating locally and will follow as a commit.

Validation

  • make docs renders without errors.
  • make lint typecheck test: 306 passed, 3 skipped.

🤖 Generated with Claude Code

cmg777 and others added 3 commits October 16, 2026 11:04
california_cd checks the 51- and 41-unit fits against the authors' frozen
application output (every P value, the joint no-spillover rejections),
and the defaults against v3's Section 6.2: insignificant 1989-1990 effects
and Figure 3's break-even points 17.07 and 9.66. cd_vs_mlsynth refits
every mlsynth fixture. The report header now covers both models.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- docs/models/cd.qmd is rewritten in the shape of the sar page: setup,
  the spillover model (Examples 1-3 and custom structures, several treated
  units), estimation (including the efficient estimator), inference, the
  structure checks (kappa_A, selection, sensitivity), an accessor table,
  and where scspill departs from the authors' code and from mlsynth.
- New case study, prop99-spillovers.qmd (executed and frozen, with a
  Colab notebook): cd on Cao & Dowd's panel, the spillovers and their
  tests, the structure test, the sensitivity analysis, and a side-by-side
  comparison with sar.
- New article, articles/cd-replication.qmd: the paper's statements, the
  authors' application output and simulation statistics, and mlsynth,
  reproduced live.
- The navbar gains a Case studies menu (Prop 99 and Sudan). The catalogue,
  landing page, Get started, datasets article, For-AI page, llms.txt,
  quartodoc sections, README, CITATION abstract and package docstrings now
  describe two models.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Includes the two new cd cases (california_cd, cd_vs_mlsynth) alongside
the five sar cases.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cmg777
cmg777 changed the base branch from feat/cd-features to main October 16, 2026 02:33
@cmg777
cmg777 merged commit 8704c38 into main Oct 16, 2026
6 checks passed
@cmg777
cmg777 deleted the docs/cd-model branch October 16, 2026 02:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant