Skip to content

Commit 8f92bc9

Browse files
authored
Merge pull request #239 from igerber/ai-practitioner-guide
Add AI practitioner guardrails (Baker et al. 2025)
2 parents 92b4d97 + 510fdec commit 8f92bc9

10 files changed

Lines changed: 2054 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ category (`Methodology/Correctness`, `Performance`, or `Testing/Docs`):
138138
| `CONTRIBUTING.md` | Documentation requirements, test writing guidelines |
139139
| `.claude/commands/dev-checklists.md` | Checklists for params, methodology, warnings, reviews, bugs (run `/dev-checklists`) |
140140
| `.claude/memory.md` | Debugging patterns, tolerances, API conventions (git-tracked) |
141+
| `docs/llms-practitioner.txt` | Baker et al. (2025) 8-step practitioner workflow for AI agents |
141142
| `docs/performance-plan.md` | Performance optimization details |
142143
| `docs/benchmarks.rst` | Validation results vs R |
143144

TODO.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ Deferred items from PR reviews that were not addressed before merge.
8080
| ~376 `duplicate object description` Sphinx warnings — caused by autodoc `:members:` on dataclass attributes within manual API pages (not from autosummary stubs); fix requires restructuring `docs/api/*.rst` pages to avoid documenting the same attribute via both `:members:` and inline `autosummary` tables | `docs/api/*.rst` || Low |
8181
| Plotly renderers silently ignore styling kwargs (marker, markersize, linewidth, capsize, ci_linewidth) that the matplotlib backend honors; thread them through or reject when `backend="plotly"` | `visualization/_event_study.py`, `_diagnostic.py`, `_power.py` | #222 | Medium |
8282
| Survey bootstrap test coverage — **Resolved**. Added FPC census zero-variance, single-PSU NaN, full-design bootstrap for CS/ContinuousDiD/EfficientDiD, and TROP Rao-Wu vs block bootstrap equivalence tests. | `tests/test_survey_phase*.py` || Resolved |
83+
| Doc-snippet smoke tests only cover `.rst` files; new `.txt` AI guides are outside CI validation | `tests/test_doc_snippets.py` | #239 | Low |
8384

8485
---
8586

diff_diff/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@
168168
plot_staircase,
169169
plot_synth_weights,
170170
)
171+
from diff_diff.practitioner import practitioner_next_steps
171172
from diff_diff.datasets import (
172173
clear_cache,
173174
list_datasets,
@@ -344,4 +345,6 @@
344345
"load_dataset",
345346
"list_datasets",
346347
"clear_cache",
348+
# Practitioner guidance
349+
"practitioner_next_steps",
347350
]

0 commit comments

Comments
 (0)