docs: cross-link new ITS sensitivity walkthrough#877
Closed
drbenvincent wants to merge 1 commit into
Closed
Conversation
Two small follow-ups to PR #821 to improve discoverability of the ITS sensitivity walkthrough now hosted in its_post_intervention_analysis.ipynb: - sensitivity_checks.md: add the walkthrough to the "Where examples already exist" list (PlaceboInTime + PersistenceCheck) and to the bottom :::{seealso} block. - its_pymc.ipynb: add a closing "Going further: sensitivity checks" section pointing to the central guide and the worked walkthrough. Re-executed its_pymc.ipynb in the CausalPy env so committed outputs reflect the new structure. Refs #788 Made-with: Cursor
drbenvincent
added
documentation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #877 +/- ##
==========================================
- Coverage 94.60% 94.59% -0.02%
==========================================
Files 80 80
Lines 12764 12764
Branches 770 770
==========================================
- Hits 12076 12074 -2
- Misses 485 486 +1
- Partials 203 204 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Collaborator
Author
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
1 participant
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.
Two small follow-ups to PR #821 to improve discoverability of the new ITS sensitivity walkthrough.
Summary
docs/source/notebooks/sensitivity_checks.md: addits_post_intervention_analysisto the "Where examples already exist" list (under bothPlaceboInTimeandPersistenceCheck) and to the closing:::{seealso}block.docs/source/notebooks/its_pymc.ipynb: add a closing "Going further: sensitivity checks" markdown section pointing readers to the central guide, the worked walkthrough, and the pipeline tutorial.This is the polish pass agreed on in #788 — we deliberately avoided propagating the full sensitivity walkthrough to every ITS variant to prevent boilerplate duplication and pedagogical dilution.
Test plan
prek run --files docs/source/notebooks/sensitivity_checks.md docs/source/notebooks/its_pymc.ipynb— all hooks pass (notebook schema, ruff format, codespell, etc.)its_pymc.ipynbre-executed end-to-end in theCausalPyconda env so committed outputs are freshseealsolinks resolveRefs #788
Made with Cursor