docs: clarify DiD predict support contract#580
Draft
shawcharles wants to merge 1 commit into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #579.
Summary
This PR clarifies the current
DifferenceInDifferences.predict()contract without adding prediction semantics.predict()is present on the sklearn-like estimator surface, but it currently raisesNotImplementedError. The updated docs and error message make that explicit: out-of-sample prediction is unsupported pending a broader post-estimation result-object design, and fitted training-data predictions are available throughresults_.fitted_valuesafterfit().Changes
DifferenceInDifferences.predict()docstring andNotImplementedErrormessage.predict()unsupported contract.predictin theDifferenceInDifferencesmethod autosummary.Validation
PYTHONPATH=. DIFF_DIFF_BACKEND=python pytest tests/test_methodology_did.py::TestResultsObject::test_predict_contract_points_to_fitted_values -qPYTHONPATH=. DIFF_DIFF_BACKEND=python pytest tests/test_methodology_did.py::TestResultsObject -qPYTHONPATH=. DIFF_DIFF_BACKEND=python pytest tests/test_methodology_did.py -qPYTHONPATH=. DIFF_DIFF_BACKEND=python .venv-py39/bin/python -m pytest tests/test_methodology_did.py::TestResultsObject::test_predict_contract_points_to_fitted_values -qpython -m ruff check diff_diff/estimators.pygit diff --checkDocs build note:
make -C docs html SPHINXOPTS="-W"currently reaches completion but exits non-zero on pre-existing tutorial 19DIDunknown-target warnings. Those warnings are addressed separately in PR #572.Security / privacy
Confirmed: no secrets or PII in this PR.