From bdf987f566d8adcf143716c80e863d838e90976c Mon Sep 17 00:00:00 2001 From: igerber Date: Fri, 15 May 2026 07:30:13 -0400 Subject: [PATCH 1/4] Add :no-index: orphan classes to API autosummary PR #407 added :no-index: to page-level autoclass directives, which is correct for classes that also have a generated _autosummary stub. For 9 classes there was no stub, so :no-index: orphaned them: the class loses its only inventory entry and any :class: cross-reference (e.g. index.rst:108 :class:`~diff_diff.PanelProfile`, profile.rst:7,21 :class:`Alert` / :class:`OutcomeShape` / :class:`TreatmentDoseShape`) silently fails to resolve. Add the missing classes to the canonical autosummary list in index.rst: - Panel Profiling (existing block): PanelProfile, OutcomeShape, TreatmentDoseShape, Alert - Reporting (new block): BusinessReport, BusinessContext, DiagnosticReport, DiagnosticReportResults - Boundary Local-Linear Estimators (new block): LocalLinearFit, BandwidthResult, BiasCorrectedFit Stubs auto-generate via autosummary_generate_overwrite (default True); the existing custom class.rst template (added in PR #410) emits :no-members: so the new stubs do not introduce duplicate-object warnings with the page-level autoclass directives that retain :no-index:. Verified locally on main with `make -C docs html SPHINXOPTS="-W"`: build succeeds, 11 new _autosummary stubs generated, and the :class:`~diff_diff.PanelProfile` cross-ref in api/index.rst renders with href="_autosummary/diff_diff.PanelProfile.html". Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/api/index.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/api/index.rst b/docs/api/index.rst index 4cb44278..e83225dd 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -113,6 +113,10 @@ are documented in :doc:`profile`. :nosignatures: diff_diff.profile_panel + diff_diff.PanelProfile + diff_diff.OutcomeShape + diff_diff.TreatmentDoseShape + diff_diff.Alert Sensitivity Analysis -------------------- @@ -193,6 +197,36 @@ Power analysis for pre-trends tests (Roth 2022): diff_diff.compute_pretrends_power diff_diff.compute_mdv +Reporting +--------- + +Stakeholder-facing report and diagnostic battery wrappers around fitted +result objects: + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + diff_diff.BusinessReport + diff_diff.BusinessContext + diff_diff.DiagnosticReport + diff_diff.DiagnosticReportResults + +Boundary Local-Linear Estimators +-------------------------------- + +Calonico-Cattaneo-Farrell (2018) MSE-optimal bandwidth selector and +Calonico-Cattaneo-Titiunik (2014) robust-bias-corrected local-linear fit +used by the continuous-DiD boundary estimator: + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + diff_diff.LocalLinearFit + diff_diff.BandwidthResult + diff_diff.BiasCorrectedFit + Data Preparation ---------------- From c7ce00ec1a1cef76c1b52d23b9864a506fda5a2b Mon Sep 17 00:00:00 2001 From: igerber Date: Fri, 15 May 2026 07:38:15 -0400 Subject: [PATCH 2/4] R1 expansion: add 8 more orphan classes to autosummary blocks MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit R1 codex review surfaced 8 more :no-index: orphans that R0 missed: - staggered.rst:140,151 — StaggeredTripleDifference, StaggeredTripleDiffResults (cross-ref in docs/choosing_estimator.rst:19 was orphaned) - chaisemartin_dhaultfoeuille.rst:173 — TWFEWeightsResult - had.rst:167,182,188,194,209 — HADPretestReport (cross-ref in docs/api/had.rst:163 was orphaned), QUGTestResults, StuteTestResults, YatchewTestResults, StuteJointResult Add to canonical autosummary blocks in docs/api/index.rst: - Estimators: StaggeredTripleDifference - Results Classes: StaggeredTripleDiffResults, TWFEWeightsResult - New HAD Pretest Workflow section: HADPretestReport, QUGTestResults, StuteTestResults, YatchewTestResults, StuteJointResult Verified locally with `make -C docs html SPHINXOPTS="-W"`: build succeeds, 8 new _autosummary stubs generated, cross-refs to StaggeredTripleDifference (from choosing_estimator.rst) and HADPretestReport (from api/had.rst) now resolve. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/api/index.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/api/index.rst b/docs/api/index.rst index e83225dd..6a4a3161 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -29,6 +29,7 @@ Core estimator classes for DiD analysis: diff_diff.TwoStageDiD diff_diff.WooldridgeDiD diff_diff.BaconDecomposition + diff_diff.StaggeredTripleDifference Results Classes --------------- @@ -66,6 +67,8 @@ Result containers returned by estimators: diff_diff.BaconDecompositionResults diff_diff.wooldridge_results.WooldridgeDiDResults diff_diff.Comparison2x2 + diff_diff.StaggeredTripleDiffResults + diff_diff.TWFEWeightsResult Visualization ------------- @@ -149,6 +152,22 @@ Testing the parallel trends assumption: diff_diff.check_parallel_trends_robust diff_diff.equivalence_test_trends +HAD Pretest Workflow +-------------------- + +Companion pretest battery for ``HeterogeneousAdoptionDiD`` (Baker et al. +2025 QUG/Stute/Yatchew tests + unified report wrapper): + +.. autosummary:: + :toctree: _autosummary + :nosignatures: + + diff_diff.HADPretestReport + diff_diff.QUGTestResults + diff_diff.StuteTestResults + diff_diff.YatchewTestResults + diff_diff.StuteJointResult + Bootstrap Inference ------------------- From b3dccf27ceec62f624236b44e16f31c06d823d44 Mon Sep 17 00:00:00 2001 From: igerber Date: Fri, 15 May 2026 07:45:42 -0400 Subject: [PATCH 3/4] Fix prose attributions in new autosummary blocks R2 codex flagged two methodology mis-attributions in the prose I added: 1. HAD Pretest Workflow: cited "Baker et al. 2025" but the actual workflow is Section 4 of de Chaisemartin, Ciccia, D'Haultfoeuille & Knau (2026), per docs/api/had.rst:9-10, diff_diff/had_pretests.py:1-3, and docs/methodology/REGISTRY.md:2480-2489. 2. Boundary Local-Linear Estimators: said "used by the continuous-DiD boundary estimator" but per docs/api/local_linear.rst:8-11 and diff_diff/had.py:49-53 these are the nonparametric building blocks for HeterogeneousAdoptionDiD's continuous-dose fit paths (continuous_at_zero, continuous_near_d_lower), not ContinuousDiD. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/api/index.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/api/index.rst b/docs/api/index.rst index 6a4a3161..bdb1f086 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -155,8 +155,9 @@ Testing the parallel trends assumption: HAD Pretest Workflow -------------------- -Companion pretest battery for ``HeterogeneousAdoptionDiD`` (Baker et al. -2025 QUG/Stute/Yatchew tests + unified report wrapper): +Companion pretest battery for ``HeterogeneousAdoptionDiD`` implementing the +Section 4 QUG / Stute / Yatchew tests from de Chaisemartin, Ciccia, +D'Haultfœuille & Knau (2026), plus a unified report wrapper: .. autosummary:: :toctree: _autosummary @@ -236,7 +237,8 @@ Boundary Local-Linear Estimators Calonico-Cattaneo-Farrell (2018) MSE-optimal bandwidth selector and Calonico-Cattaneo-Titiunik (2014) robust-bias-corrected local-linear fit -used by the continuous-DiD boundary estimator: +used by ``HeterogeneousAdoptionDiD``'s continuous-dose fit paths +(``continuous_at_zero`` and ``continuous_near_d_lower``): .. autosummary:: :toctree: _autosummary From 68a6972dca611110147d53a1f40fc7eddd7c9694 Mon Sep 17 00:00:00 2001 From: igerber Date: Fri, 15 May 2026 07:51:26 -0400 Subject: [PATCH 4/4] Commit 19 auto-generated _autosummary stubs The autosummary directives added in the prior 3 commits expand at build time into stubs at docs/api/_autosummary/diff_diff..rst via autosummary_generate_overwrite=True (default). The repo convention is to commit these stubs (111 already tracked); commit the 19 new ones for the orphan classes restored to the inventory: - Panel Profiling: Alert, OutcomeShape, PanelProfile, TreatmentDoseShape - Reporting: BusinessContext, BusinessReport, DiagnosticReport, DiagnosticReportResults - Boundary Local-Linear: BandwidthResult, BiasCorrectedFit, LocalLinearFit - Estimators / Results: StaggeredTripleDifference, StaggeredTripleDiffResults, TWFEWeightsResult - HAD Pretest Workflow: HADPretestReport, QUGTestResults, StuteJointResult, StuteTestResults, YatchewTestResults Stubs use the custom class.rst template added in PR #410 (auto-emits :no-members:), so they register the canonical inventory target without triggering duplicate-object warnings against the page-level autoclass directives that retain :no-index:. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/api/_autosummary/diff_diff.Alert.rst | 27 ++++++++ .../diff_diff.BandwidthResult.rst | 47 +++++++++++++ .../diff_diff.BiasCorrectedFit.rst | 39 +++++++++++ .../diff_diff.BusinessContext.rst | 29 ++++++++ .../_autosummary/diff_diff.BusinessReport.rst | 25 +++++++ .../diff_diff.DiagnosticReport.rst | 31 +++++++++ .../diff_diff.DiagnosticReportResults.rst | 28 ++++++++ .../diff_diff.HADPretestReport.rst | 37 ++++++++++ .../_autosummary/diff_diff.LocalLinearFit.rst | 32 +++++++++ .../_autosummary/diff_diff.OutcomeShape.rst | 32 +++++++++ .../_autosummary/diff_diff.PanelProfile.rst | 49 ++++++++++++++ .../_autosummary/diff_diff.QUGTestResults.rst | 36 ++++++++++ .../diff_diff.StaggeredTripleDiffResults.rst | 67 +++++++++++++++++++ .../diff_diff.StaggeredTripleDifference.rst | 32 +++++++++ .../diff_diff.StuteJointResult.rst | 39 +++++++++++ .../diff_diff.StuteTestResults.rst | 34 ++++++++++ .../diff_diff.TWFEWeightsResult.rst | 27 ++++++++ .../diff_diff.TreatmentDoseShape.rst | 28 ++++++++ .../diff_diff.YatchewTestResults.rst | 37 ++++++++++ 19 files changed, 676 insertions(+) create mode 100644 docs/api/_autosummary/diff_diff.Alert.rst create mode 100644 docs/api/_autosummary/diff_diff.BandwidthResult.rst create mode 100644 docs/api/_autosummary/diff_diff.BiasCorrectedFit.rst create mode 100644 docs/api/_autosummary/diff_diff.BusinessContext.rst create mode 100644 docs/api/_autosummary/diff_diff.BusinessReport.rst create mode 100644 docs/api/_autosummary/diff_diff.DiagnosticReport.rst create mode 100644 docs/api/_autosummary/diff_diff.DiagnosticReportResults.rst create mode 100644 docs/api/_autosummary/diff_diff.HADPretestReport.rst create mode 100644 docs/api/_autosummary/diff_diff.LocalLinearFit.rst create mode 100644 docs/api/_autosummary/diff_diff.OutcomeShape.rst create mode 100644 docs/api/_autosummary/diff_diff.PanelProfile.rst create mode 100644 docs/api/_autosummary/diff_diff.QUGTestResults.rst create mode 100644 docs/api/_autosummary/diff_diff.StaggeredTripleDiffResults.rst create mode 100644 docs/api/_autosummary/diff_diff.StaggeredTripleDifference.rst create mode 100644 docs/api/_autosummary/diff_diff.StuteJointResult.rst create mode 100644 docs/api/_autosummary/diff_diff.StuteTestResults.rst create mode 100644 docs/api/_autosummary/diff_diff.TWFEWeightsResult.rst create mode 100644 docs/api/_autosummary/diff_diff.TreatmentDoseShape.rst create mode 100644 docs/api/_autosummary/diff_diff.YatchewTestResults.rst diff --git a/docs/api/_autosummary/diff_diff.Alert.rst b/docs/api/_autosummary/diff_diff.Alert.rst new file mode 100644 index 00000000..7ee63395 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.Alert.rst @@ -0,0 +1,27 @@ +diff\_diff.Alert +================ + +.. currentmodule:: diff_diff + +.. autoclass:: Alert + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~Alert.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~Alert.code + ~Alert.severity + ~Alert.message + ~Alert.observed + diff --git a/docs/api/_autosummary/diff_diff.BandwidthResult.rst b/docs/api/_autosummary/diff_diff.BandwidthResult.rst new file mode 100644 index 00000000..6a245c9c --- /dev/null +++ b/docs/api/_autosummary/diff_diff.BandwidthResult.rst @@ -0,0 +1,47 @@ +diff\_diff.BandwidthResult +========================== + +.. currentmodule:: diff_diff + +.. autoclass:: BandwidthResult + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~BandwidthResult.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~BandwidthResult.h_mse + ~BandwidthResult.b_mse + ~BandwidthResult.c_bw + ~BandwidthResult.bw_mp2 + ~BandwidthResult.bw_mp3 + ~BandwidthResult.stage_d1_V + ~BandwidthResult.stage_d1_B1 + ~BandwidthResult.stage_d1_B2 + ~BandwidthResult.stage_d1_R + ~BandwidthResult.stage_d2_V + ~BandwidthResult.stage_d2_B1 + ~BandwidthResult.stage_d2_B2 + ~BandwidthResult.stage_d2_R + ~BandwidthResult.stage_b_V + ~BandwidthResult.stage_b_B1 + ~BandwidthResult.stage_b_B2 + ~BandwidthResult.stage_b_R + ~BandwidthResult.stage_h_V + ~BandwidthResult.stage_h_B1 + ~BandwidthResult.stage_h_B2 + ~BandwidthResult.stage_h_R + ~BandwidthResult.n + ~BandwidthResult.kernel + ~BandwidthResult.boundary + diff --git a/docs/api/_autosummary/diff_diff.BiasCorrectedFit.rst b/docs/api/_autosummary/diff_diff.BiasCorrectedFit.rst new file mode 100644 index 00000000..068274ff --- /dev/null +++ b/docs/api/_autosummary/diff_diff.BiasCorrectedFit.rst @@ -0,0 +1,39 @@ +diff\_diff.BiasCorrectedFit +=========================== + +.. currentmodule:: diff_diff + +.. autoclass:: BiasCorrectedFit + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~BiasCorrectedFit.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~BiasCorrectedFit.influence_function + ~BiasCorrectedFit.estimate_classical + ~BiasCorrectedFit.estimate_bias_corrected + ~BiasCorrectedFit.se_classical + ~BiasCorrectedFit.se_robust + ~BiasCorrectedFit.ci_low + ~BiasCorrectedFit.ci_high + ~BiasCorrectedFit.alpha + ~BiasCorrectedFit.h + ~BiasCorrectedFit.b + ~BiasCorrectedFit.bandwidth_source + ~BiasCorrectedFit.bandwidth_diagnostics + ~BiasCorrectedFit.n_used + ~BiasCorrectedFit.n_total + ~BiasCorrectedFit.kernel + ~BiasCorrectedFit.boundary + diff --git a/docs/api/_autosummary/diff_diff.BusinessContext.rst b/docs/api/_autosummary/diff_diff.BusinessContext.rst new file mode 100644 index 00000000..7ed6c0a5 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.BusinessContext.rst @@ -0,0 +1,29 @@ +diff\_diff.BusinessContext +========================== + +.. currentmodule:: diff_diff + +.. autoclass:: BusinessContext + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~BusinessContext.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~BusinessContext.outcome_label + ~BusinessContext.outcome_unit + ~BusinessContext.outcome_direction + ~BusinessContext.business_question + ~BusinessContext.treatment_label + ~BusinessContext.alpha + diff --git a/docs/api/_autosummary/diff_diff.BusinessReport.rst b/docs/api/_autosummary/diff_diff.BusinessReport.rst new file mode 100644 index 00000000..f87bb423 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.BusinessReport.rst @@ -0,0 +1,25 @@ +diff\_diff.BusinessReport +========================= + +.. currentmodule:: diff_diff + +.. autoclass:: BusinessReport + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~BusinessReport.__init__ + ~BusinessReport.caveats + ~BusinessReport.export_markdown + ~BusinessReport.full_report + ~BusinessReport.headline + ~BusinessReport.summary + ~BusinessReport.to_dict + ~BusinessReport.to_json + + + + diff --git a/docs/api/_autosummary/diff_diff.DiagnosticReport.rst b/docs/api/_autosummary/diff_diff.DiagnosticReport.rst new file mode 100644 index 00000000..7a74bbf6 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.DiagnosticReport.rst @@ -0,0 +1,31 @@ +diff\_diff.DiagnosticReport +=========================== + +.. currentmodule:: diff_diff + +.. autoclass:: DiagnosticReport + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~DiagnosticReport.__init__ + ~DiagnosticReport.export_markdown + ~DiagnosticReport.full_report + ~DiagnosticReport.run_all + ~DiagnosticReport.summary + ~DiagnosticReport.to_dataframe + ~DiagnosticReport.to_dict + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~DiagnosticReport.applicable_checks + ~DiagnosticReport.skipped_checks + diff --git a/docs/api/_autosummary/diff_diff.DiagnosticReportResults.rst b/docs/api/_autosummary/diff_diff.DiagnosticReportResults.rst new file mode 100644 index 00000000..b16d7a51 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.DiagnosticReportResults.rst @@ -0,0 +1,28 @@ +diff\_diff.DiagnosticReportResults +================================== + +.. currentmodule:: diff_diff + +.. autoclass:: DiagnosticReportResults + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~DiagnosticReportResults.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~DiagnosticReportResults.warnings + ~DiagnosticReportResults.schema + ~DiagnosticReportResults.interpretation + ~DiagnosticReportResults.applicable_checks + ~DiagnosticReportResults.skipped_checks + diff --git a/docs/api/_autosummary/diff_diff.HADPretestReport.rst b/docs/api/_autosummary/diff_diff.HADPretestReport.rst new file mode 100644 index 00000000..106e21dc --- /dev/null +++ b/docs/api/_autosummary/diff_diff.HADPretestReport.rst @@ -0,0 +1,37 @@ +diff\_diff.HADPretestReport +=========================== + +.. currentmodule:: diff_diff + +.. autoclass:: HADPretestReport + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~HADPretestReport.__init__ + ~HADPretestReport.print_summary + ~HADPretestReport.summary + ~HADPretestReport.to_dataframe + ~HADPretestReport.to_dict + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~HADPretestReport.aggregate + ~HADPretestReport.homogeneity_joint + ~HADPretestReport.pretrends_joint + ~HADPretestReport.qug + ~HADPretestReport.stute + ~HADPretestReport.yatchew + ~HADPretestReport.all_pass + ~HADPretestReport.verdict + ~HADPretestReport.alpha + ~HADPretestReport.n_obs + diff --git a/docs/api/_autosummary/diff_diff.LocalLinearFit.rst b/docs/api/_autosummary/diff_diff.LocalLinearFit.rst new file mode 100644 index 00000000..c055db37 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.LocalLinearFit.rst @@ -0,0 +1,32 @@ +diff\_diff.LocalLinearFit +========================= + +.. currentmodule:: diff_diff + +.. autoclass:: LocalLinearFit + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~LocalLinearFit.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~LocalLinearFit.intercept + ~LocalLinearFit.slope + ~LocalLinearFit.n_effective + ~LocalLinearFit.bandwidth + ~LocalLinearFit.kernel + ~LocalLinearFit.boundary + ~LocalLinearFit.residuals + ~LocalLinearFit.kernel_weights + ~LocalLinearFit.design_matrix + diff --git a/docs/api/_autosummary/diff_diff.OutcomeShape.rst b/docs/api/_autosummary/diff_diff.OutcomeShape.rst new file mode 100644 index 00000000..09924d7d --- /dev/null +++ b/docs/api/_autosummary/diff_diff.OutcomeShape.rst @@ -0,0 +1,32 @@ +diff\_diff.OutcomeShape +======================= + +.. currentmodule:: diff_diff + +.. autoclass:: OutcomeShape + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~OutcomeShape.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~OutcomeShape.n_distinct_values + ~OutcomeShape.pct_zeros + ~OutcomeShape.value_min + ~OutcomeShape.value_max + ~OutcomeShape.skewness + ~OutcomeShape.excess_kurtosis + ~OutcomeShape.is_integer_valued + ~OutcomeShape.is_count_like + ~OutcomeShape.is_bounded_unit + diff --git a/docs/api/_autosummary/diff_diff.PanelProfile.rst b/docs/api/_autosummary/diff_diff.PanelProfile.rst new file mode 100644 index 00000000..48148d0e --- /dev/null +++ b/docs/api/_autosummary/diff_diff.PanelProfile.rst @@ -0,0 +1,49 @@ +diff\_diff.PanelProfile +======================= + +.. currentmodule:: diff_diff + +.. autoclass:: PanelProfile + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~PanelProfile.__init__ + ~PanelProfile.to_dict + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~PanelProfile.outcome_shape + ~PanelProfile.treatment_dose + ~PanelProfile.n_units + ~PanelProfile.n_periods + ~PanelProfile.n_obs + ~PanelProfile.is_balanced + ~PanelProfile.observation_coverage + ~PanelProfile.treatment_type + ~PanelProfile.is_staggered + ~PanelProfile.n_cohorts + ~PanelProfile.cohort_sizes + ~PanelProfile.has_never_treated + ~PanelProfile.has_always_treated + ~PanelProfile.treatment_varies_within_unit + ~PanelProfile.first_treatment_period + ~PanelProfile.last_treatment_period + ~PanelProfile.min_pre_periods + ~PanelProfile.min_post_periods + ~PanelProfile.outcome_dtype + ~PanelProfile.outcome_is_binary + ~PanelProfile.outcome_has_zeros + ~PanelProfile.outcome_has_negatives + ~PanelProfile.outcome_missing_fraction + ~PanelProfile.outcome_summary + ~PanelProfile.alerts + diff --git a/docs/api/_autosummary/diff_diff.QUGTestResults.rst b/docs/api/_autosummary/diff_diff.QUGTestResults.rst new file mode 100644 index 00000000..891965aa --- /dev/null +++ b/docs/api/_autosummary/diff_diff.QUGTestResults.rst @@ -0,0 +1,36 @@ +diff\_diff.QUGTestResults +========================= + +.. currentmodule:: diff_diff + +.. autoclass:: QUGTestResults + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~QUGTestResults.__init__ + ~QUGTestResults.print_summary + ~QUGTestResults.summary + ~QUGTestResults.to_dataframe + ~QUGTestResults.to_dict + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~QUGTestResults.t_stat + ~QUGTestResults.p_value + ~QUGTestResults.reject + ~QUGTestResults.alpha + ~QUGTestResults.critical_value + ~QUGTestResults.n_obs + ~QUGTestResults.n_excluded_zero + ~QUGTestResults.d_order_1 + ~QUGTestResults.d_order_2 + diff --git a/docs/api/_autosummary/diff_diff.StaggeredTripleDiffResults.rst b/docs/api/_autosummary/diff_diff.StaggeredTripleDiffResults.rst new file mode 100644 index 00000000..70bbf478 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.StaggeredTripleDiffResults.rst @@ -0,0 +1,67 @@ +diff\_diff.StaggeredTripleDiffResults +===================================== + +.. currentmodule:: diff_diff + +.. autoclass:: StaggeredTripleDiffResults + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~StaggeredTripleDiffResults.__init__ + ~StaggeredTripleDiffResults.epv_summary + ~StaggeredTripleDiffResults.print_summary + ~StaggeredTripleDiffResults.summary + ~StaggeredTripleDiffResults.to_dataframe + ~StaggeredTripleDiffResults.to_dict + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~StaggeredTripleDiffResults.alpha + ~StaggeredTripleDiffResults.anticipation + ~StaggeredTripleDiffResults.att + ~StaggeredTripleDiffResults.base_period + ~StaggeredTripleDiffResults.bootstrap_results + ~StaggeredTripleDiffResults.cband_crit_value + ~StaggeredTripleDiffResults.coef_var + ~StaggeredTripleDiffResults.comparison_group_counts + ~StaggeredTripleDiffResults.conf_int + ~StaggeredTripleDiffResults.control_group + ~StaggeredTripleDiffResults.epv_diagnostics + ~StaggeredTripleDiffResults.epv_threshold + ~StaggeredTripleDiffResults.estimation_method + ~StaggeredTripleDiffResults.event_study_effects + ~StaggeredTripleDiffResults.gmm_weights + ~StaggeredTripleDiffResults.group_effects + ~StaggeredTripleDiffResults.influence_functions + ~StaggeredTripleDiffResults.is_significant + ~StaggeredTripleDiffResults.p_value + ~StaggeredTripleDiffResults.pscore_fallback + ~StaggeredTripleDiffResults.pscore_trim + ~StaggeredTripleDiffResults.se + ~StaggeredTripleDiffResults.significance_stars + ~StaggeredTripleDiffResults.survey_metadata + ~StaggeredTripleDiffResults.t_stat + ~StaggeredTripleDiffResults.group_time_effects + ~StaggeredTripleDiffResults.overall_att + ~StaggeredTripleDiffResults.overall_se + ~StaggeredTripleDiffResults.overall_t_stat + ~StaggeredTripleDiffResults.overall_p_value + ~StaggeredTripleDiffResults.overall_conf_int + ~StaggeredTripleDiffResults.groups + ~StaggeredTripleDiffResults.time_periods + ~StaggeredTripleDiffResults.n_obs + ~StaggeredTripleDiffResults.n_treated_units + ~StaggeredTripleDiffResults.n_control_units + ~StaggeredTripleDiffResults.n_never_enabled + ~StaggeredTripleDiffResults.n_eligible + ~StaggeredTripleDiffResults.n_ineligible + diff --git a/docs/api/_autosummary/diff_diff.StaggeredTripleDifference.rst b/docs/api/_autosummary/diff_diff.StaggeredTripleDifference.rst new file mode 100644 index 00000000..00893a63 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.StaggeredTripleDifference.rst @@ -0,0 +1,32 @@ +diff\_diff.StaggeredTripleDifference +==================================== + +.. currentmodule:: diff_diff + +.. autoclass:: StaggeredTripleDifference + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~StaggeredTripleDifference.__init__ + ~StaggeredTripleDifference.fit + ~StaggeredTripleDifference.get_params + ~StaggeredTripleDifference.set_params + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~StaggeredTripleDifference.n_bootstrap + ~StaggeredTripleDifference.bootstrap_weights + ~StaggeredTripleDifference.alpha + ~StaggeredTripleDifference.seed + ~StaggeredTripleDifference.anticipation + ~StaggeredTripleDifference.base_period + diff --git a/docs/api/_autosummary/diff_diff.StuteJointResult.rst b/docs/api/_autosummary/diff_diff.StuteJointResult.rst new file mode 100644 index 00000000..1afe5b27 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.StuteJointResult.rst @@ -0,0 +1,39 @@ +diff\_diff.StuteJointResult +=========================== + +.. currentmodule:: diff_diff + +.. autoclass:: StuteJointResult + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~StuteJointResult.__init__ + ~StuteJointResult.print_summary + ~StuteJointResult.summary + ~StuteJointResult.to_dataframe + ~StuteJointResult.to_dict + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~StuteJointResult.cvm_stat_joint + ~StuteJointResult.p_value + ~StuteJointResult.reject + ~StuteJointResult.alpha + ~StuteJointResult.horizon_labels + ~StuteJointResult.per_horizon_stats + ~StuteJointResult.n_bootstrap + ~StuteJointResult.n_obs + ~StuteJointResult.n_horizons + ~StuteJointResult.seed + ~StuteJointResult.null_form + ~StuteJointResult.exact_linear_short_circuited + diff --git a/docs/api/_autosummary/diff_diff.StuteTestResults.rst b/docs/api/_autosummary/diff_diff.StuteTestResults.rst new file mode 100644 index 00000000..61a84ad5 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.StuteTestResults.rst @@ -0,0 +1,34 @@ +diff\_diff.StuteTestResults +=========================== + +.. currentmodule:: diff_diff + +.. autoclass:: StuteTestResults + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~StuteTestResults.__init__ + ~StuteTestResults.print_summary + ~StuteTestResults.summary + ~StuteTestResults.to_dataframe + ~StuteTestResults.to_dict + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~StuteTestResults.cvm_stat + ~StuteTestResults.p_value + ~StuteTestResults.reject + ~StuteTestResults.alpha + ~StuteTestResults.n_bootstrap + ~StuteTestResults.n_obs + ~StuteTestResults.seed + diff --git a/docs/api/_autosummary/diff_diff.TWFEWeightsResult.rst b/docs/api/_autosummary/diff_diff.TWFEWeightsResult.rst new file mode 100644 index 00000000..6b8aa5fa --- /dev/null +++ b/docs/api/_autosummary/diff_diff.TWFEWeightsResult.rst @@ -0,0 +1,27 @@ +diff\_diff.TWFEWeightsResult +============================ + +.. currentmodule:: diff_diff + +.. autoclass:: TWFEWeightsResult + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~TWFEWeightsResult.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~TWFEWeightsResult.weights + ~TWFEWeightsResult.fraction_negative + ~TWFEWeightsResult.sigma_fe + ~TWFEWeightsResult.beta_fe + diff --git a/docs/api/_autosummary/diff_diff.TreatmentDoseShape.rst b/docs/api/_autosummary/diff_diff.TreatmentDoseShape.rst new file mode 100644 index 00000000..bef1d3bf --- /dev/null +++ b/docs/api/_autosummary/diff_diff.TreatmentDoseShape.rst @@ -0,0 +1,28 @@ +diff\_diff.TreatmentDoseShape +============================= + +.. currentmodule:: diff_diff + +.. autoclass:: TreatmentDoseShape + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~TreatmentDoseShape.__init__ + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~TreatmentDoseShape.n_distinct_doses + ~TreatmentDoseShape.has_zero_dose + ~TreatmentDoseShape.dose_min + ~TreatmentDoseShape.dose_max + ~TreatmentDoseShape.dose_mean + diff --git a/docs/api/_autosummary/diff_diff.YatchewTestResults.rst b/docs/api/_autosummary/diff_diff.YatchewTestResults.rst new file mode 100644 index 00000000..ebf20a87 --- /dev/null +++ b/docs/api/_autosummary/diff_diff.YatchewTestResults.rst @@ -0,0 +1,37 @@ +diff\_diff.YatchewTestResults +============================= + +.. currentmodule:: diff_diff + +.. autoclass:: YatchewTestResults + :no-members: + + + .. rubric:: Methods + + .. autosummary:: + + ~YatchewTestResults.__init__ + ~YatchewTestResults.print_summary + ~YatchewTestResults.summary + ~YatchewTestResults.to_dataframe + ~YatchewTestResults.to_dict + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~YatchewTestResults.null_form + ~YatchewTestResults.t_stat_hr + ~YatchewTestResults.p_value + ~YatchewTestResults.reject + ~YatchewTestResults.alpha + ~YatchewTestResults.critical_value + ~YatchewTestResults.sigma2_lin + ~YatchewTestResults.sigma2_diff + ~YatchewTestResults.sigma2_W + ~YatchewTestResults.n_obs +