Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ Signif. codes: '***' 0.001, '**' 0.01, '*' 0.05, '.' 0.1
======================================================================
```

## For AI Agents

If you are an AI agent or LLM using this library, read [`docs/llms.txt`](docs/llms.txt) for a concise API reference with an 8-step practitioner workflow (based on Baker et al. 2025). The workflow ensures rigorous DiD analysis — not just calling `fit()`, but testing assumptions, running sensitivity analysis, and checking robustness.

After estimation, call `practitioner_next_steps(results)` for context-aware guidance on remaining diagnostic steps.

Detailed guide: [`docs/llms-practitioner.txt`](docs/llms-practitioner.txt)

## Features

- **sklearn-like API**: Familiar `fit()` interface with `get_params()` and `set_params()`
Expand Down
7 changes: 7 additions & 0 deletions diff_diff/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
This library provides sklearn-like estimators for causal inference
using the difference-in-differences methodology.
For rigorous analysis, follow the 8-step practitioner workflow in
docs/llms-practitioner.txt (based on Baker et al. 2025). After
estimation, call ``practitioner_next_steps(results)`` for context-aware
guidance on remaining diagnostic steps.
AI agent reference: docs/llms.txt
"""

# Import backend detection from dedicated module (avoids circular imports)
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ Homepage = "https://github.com/igerber/diff-diff"
Documentation = "https://diff-diff.readthedocs.io"
Repository = "https://github.com/igerber/diff-diff"
Issues = "https://github.com/igerber/diff-diff/issues"
"Practitioner Guide" = "https://github.com/igerber/diff-diff/blob/main/docs/llms-practitioner.txt"

[tool.maturin]
# Build the Rust extension module
Expand Down
Loading