docs: clarify DiD predict support contract by shawcharles · Pull Request #580 · igerber/diff-diff · GitHub
Skip to content
Draft
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
25 changes: 19 additions & 6 deletions diff_diff/estimators.py
7 changes: 6 additions & 1 deletion docs/api/estimators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ DifferenceInDifferences (alias: ``DiD``)

Basic 2x2 DiD estimator.

``DifferenceInDifferences.predict()`` is present for sklearn-like
discoverability, but out-of-sample prediction is not currently supported. Use
``results_.fitted_values`` for fitted training-data predictions until a broader
post-estimation result-object contract is designed.

.. autoclass:: diff_diff.DifferenceInDifferences
:no-index:
:members:
Expand All @@ -42,6 +47,7 @@ Basic 2x2 DiD estimator.
.. autosummary::

~DifferenceInDifferences.fit
~DifferenceInDifferences.predict
~DifferenceInDifferences.get_params
~DifferenceInDifferences.set_params

Expand Down Expand Up @@ -84,4 +90,3 @@ Synthetic control combined with DiD (Arkhangelsky et al. 2021).
:undoc-members:
:show-inheritance:
:inherited-members:

13 changes: 13 additions & 0 deletions tests/test_methodology_did.py