diff-diff 3.2.0__tar.gz → 3.3.0__tar.gz

{diff_diff-3.2.0 → diff_diff-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diff-diff
-Version: 3.2.0
+Version: 3.3.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent

{diff_diff-3.2.0 → diff_diff-3.3.0}/diff_diff/__init__.py

@@ -4,14 +4,20 @@ diff-diff: A library for Difference-in-Differences analysis.
 This library provides sklearn-like estimators for causal inference
 using the difference-in-differences methodology.
 
-For rigorous analysis, follow the 8-step practitioner workflow based
-on Baker et al. (2025). After estimation, call
-``practitioner_next_steps(results)`` for context-aware guidance on
-remaining diagnostic steps.
+For AI agents:
 
-AI agents: call ``diff_diff.get_llm_guide()`` for a complete API reference.
-Use ``get_llm_guide("practitioner")`` for the 8-step workflow or
-``get_llm_guide("full")`` for comprehensive documentation.
+    1. Describe your data:    ``diff_diff.profile_panel(df, unit=..., time=...,
+                              treatment=..., outcome=...)``
+    2. Consult the reference: ``diff_diff.get_llm_guide("autonomous")``
+                              (estimator-support matrix + reasoning)
+    3. Follow the workflow:   ``diff_diff.get_llm_guide("practitioner")``
+                              (Baker et al. (2025) 8-step recipe)
+    4. Report results:        ``diff_diff.BusinessReport(results)``
+                              (structured agent-legible output)
+
+For a comprehensive API reference call ``diff_diff.get_llm_guide("full")``;
+``practitioner_next_steps(results)`` returns context-aware guidance after
+any estimator's ``fit()``.
 """
 
 # Import backend detection from dedicated module (avoids circular imports)
@@ -21,7 +27,6 @@ from diff_diff._backend import (
     _rust_compute_robust_vcov,
     _rust_project_simplex,
     _rust_solve_ols,
-    _rust_synthetic_weights,
 )
 
 from diff_diff.bacon import (
@@ -46,7 +51,9 @@ from diff_diff.linalg import (
 from diff_diff.local_linear import (
     KERNELS,
     BandwidthResult,
+    BiasCorrectedFit,
     LocalLinearFit,
+    bias_corrected_local_linear,
     epanechnikov_kernel,
     kernel_moments,
     local_linear_fit,
@@ -54,6 +61,25 @@ from diff_diff.local_linear import (
     triangular_kernel,
     uniform_kernel,
 )
+from diff_diff.had import (
+    HeterogeneousAdoptionDiD,
+    HeterogeneousAdoptionDiDEventStudyResults,
+    HeterogeneousAdoptionDiDResults,
+)
+from diff_diff.had_pretests import (
+    HADPretestReport,
+    QUGTestResults,
+    StuteJointResult,
+    StuteTestResults,
+    YatchewTestResults,
+    did_had_pretest_workflow,
+    joint_homogeneity_test,
+    joint_pretrends_test,
+    qug_test,
+    stute_joint_pretest,
+    stute_test,
+    yatchew_hr_test,
+)
 from diff_diff.estimators import (
     DifferenceInDifferences,
     MultiPeriodDiD,
@@ -224,6 +250,7 @@ from diff_diff.diagnostic_report import (
     DiagnosticReportResults,
 )
 from diff_diff._guides_api import get_llm_guide
+from diff_diff.profile import Alert, PanelProfile, profile_panel
 from diff_diff.datasets import (
     clear_cache,
     list_datasets,
@@ -251,8 +278,9 @@ Bacon = BaconDecomposition
 EDiD = EfficientDiD
 ETWFE = WooldridgeDiD
 DCDH = ChaisemartinDHaultfoeuille
+HAD = HeterogeneousAdoptionDiD
 
-__version__ = "3.2.0"
+__version__ = "3.3.0"
 __all__ = [
     # Estimators
     "DifferenceInDifferences",
@@ -427,6 +455,29 @@ __all__ = [
     # MSE-optimal bandwidth selector (Phase 1b for HeterogeneousAdoptionDiD)
     "BandwidthResult",
     "mse_optimal_bandwidth",
+    # Bias-corrected local-linear (Phase 1c for HeterogeneousAdoptionDiD)
+    "BiasCorrectedFit",
+    "bias_corrected_local_linear",
+    # HeterogeneousAdoptionDiD (Phase 2a single-period, Phase 2b event study)
+    "HeterogeneousAdoptionDiD",
+    "HeterogeneousAdoptionDiDResults",
+    "HeterogeneousAdoptionDiDEventStudyResults",
+    "HAD",
+    # HeterogeneousAdoptionDiD pre-test diagnostics (Phase 3)
+    "qug_test",
+    "stute_test",
+    "yatchew_hr_test",
+    "did_had_pretest_workflow",
+    "QUGTestResults",
+    "StuteTestResults",
+    "YatchewTestResults",
+    "HADPretestReport",
+    # HAD joint pre-tests (Phase 3 follow-up) — multi-period event-study
+    # workflow dispatch via did_had_pretest_workflow(aggregate="event_study")
+    "stute_joint_pretest",
+    "joint_pretrends_test",
+    "joint_homogeneity_test",
+    "StuteJointResult",
     # Datasets
     "load_card_krueger",
     "load_castle_doctrine",
@@ -443,6 +494,10 @@ __all__ = [
     "DiagnosticReport",
     "DiagnosticReportResults",
     "DIAGNOSTIC_REPORT_SCHEMA_VERSION",
+    # Panel profiling (agent-facing pre-fit describe utility)
+    "profile_panel",
+    "PanelProfile",
+    "Alert",
     # LLM guide accessor
     "get_llm_guide",
 ]

{diff_diff-3.2.0 → diff_diff-3.3.0}/diff_diff/_backend.py

@@ -19,7 +19,6 @@ _backend_env = os.environ.get("DIFF_DIFF_BACKEND", "auto").lower()
 try:
     from diff_diff._rust_backend import (
         generate_bootstrap_weights_batch as _rust_bootstrap_weights,
-        compute_synthetic_weights as _rust_synthetic_weights,
         project_simplex as _rust_project_simplex,
         solve_ols as _rust_solve_ols,
         compute_robust_vcov as _rust_compute_robust_vcov,
@@ -35,6 +34,9 @@ try:
         compute_time_weights as _rust_compute_time_weights,
         compute_noise_level as _rust_compute_noise_level,
         sc_weight_fw as _rust_sc_weight_fw,
+        sc_weight_fw_with_convergence as _rust_sc_weight_fw_with_convergence,
+        sc_weight_fw_weighted as _rust_sc_weight_fw_weighted,
+        sc_weight_fw_weighted_with_convergence as _rust_sc_weight_fw_weighted_with_convergence,
         # Diagnostics
         rust_backend_info as _rust_backend_info,
     )
@@ -43,7 +45,6 @@ try:
 except ImportError:
     _rust_available = False
     _rust_bootstrap_weights = None
-    _rust_synthetic_weights = None
     _rust_project_simplex = None
     _rust_solve_ols = None
     _rust_compute_robust_vcov = None
@@ -59,6 +60,9 @@ except ImportError:
     _rust_compute_time_weights = None
     _rust_compute_noise_level = None
     _rust_sc_weight_fw = None
+    _rust_sc_weight_fw_with_convergence = None
+    _rust_sc_weight_fw_weighted = None
+    _rust_sc_weight_fw_weighted_with_convergence = None
     _rust_backend_info = None
 
 # Determine final backend based on environment variable and availability
@@ -66,7 +70,6 @@ if _backend_env == "python":
     # Force pure Python mode - disable Rust even if available
     HAS_RUST_BACKEND = False
     _rust_bootstrap_weights = None
-    _rust_synthetic_weights = None
     _rust_project_simplex = None
     _rust_solve_ols = None
     _rust_compute_robust_vcov = None
@@ -82,6 +85,9 @@ if _backend_env == "python":
     _rust_compute_time_weights = None
     _rust_compute_noise_level = None
     _rust_sc_weight_fw = None
+    _rust_sc_weight_fw_with_convergence = None
+    _rust_sc_weight_fw_weighted = None
+    _rust_sc_weight_fw_weighted_with_convergence = None
     _rust_backend_info = None
 elif _backend_env == "rust":
     # Force Rust mode - fail if not available
@@ -115,7 +121,6 @@ __all__ = [
     "HAS_RUST_BACKEND",
     "rust_backend_info",
     "_rust_bootstrap_weights",
-    "_rust_synthetic_weights",
     "_rust_project_simplex",
     "_rust_solve_ols",
     "_rust_compute_robust_vcov",
@@ -131,4 +136,7 @@ __all__ = [
     "_rust_compute_time_weights",
     "_rust_compute_noise_level",
     "_rust_sc_weight_fw",
+    "_rust_sc_weight_fw_with_convergence",
+    "_rust_sc_weight_fw_weighted",
+    "_rust_sc_weight_fw_weighted_with_convergence",
 ]

{diff_diff-3.2.0 → diff_diff-3.3.0}/diff_diff/_guides_api.py

@@ -1,4 +1,5 @@
 """Runtime accessor for bundled LLM guide files."""
+
 from __future__ import annotations
 
 from importlib.resources import files
@@ -7,6 +8,7 @@ _VARIANT_TO_FILE = {
     "concise": "llms.txt",
     "full": "llms-full.txt",
     "practitioner": "llms-practitioner.txt",
+    "autonomous": "llms-autonomous.txt",
 }
 
 
@@ -21,6 +23,10 @@ def get_llm_guide(variant: str = "concise") -> str:
         - ``"concise"`` -- compact API reference (llms.txt)
         - ``"full"`` -- complete API documentation (llms-full.txt)
         - ``"practitioner"`` -- 8-step practitioner workflow (llms-practitioner.txt)
+        - ``"autonomous"`` -- reference guide for AI-agent use: estimator-support
+          matrix, per-design-feature reasoning, post-fit validation index, and
+          BR/DR schema (llms-autonomous.txt). Pair with
+          :func:`diff_diff.profile_panel` for pre-fit data description.
 
     Returns
     -------
@@ -42,7 +48,5 @@ def get_llm_guide(variant: str = "concise") -> str:
         filename = _VARIANT_TO_FILE[variant]
     except (KeyError, TypeError):
         valid = ", ".join(repr(k) for k in _VARIANT_TO_FILE)
-        raise ValueError(
-            f"Unknown guide variant {variant!r}. Valid options: {valid}."
-        ) from None
+        raise ValueError(f"Unknown guide variant {variant!r}. Valid options: {valid}.") from None
     return files("diff_diff.guides").joinpath(filename).read_text(encoding="utf-8")