Repository navigation
Fix the confounding parameter name in the sensitivity docstrings - #1072
VenishPaneliya wants to merge 1 commit into
Conversation
|
Thanks for the contribution! |
0c53034 to
28c108a
Compare
|
Thanks, that's much clearer than what I would have written. I've used your wording for One thing I wasn't sure about: |
sensitivity_summary and sensitivity_interval take c_y and c_t, but all six overloads documented the second one as c_d, which they do not accept. The existing description, "The level of confounding in the treatment", already matched c_t, so only the name changed. Following review, rho is now documented on all six as the worst case correlation between the estimation errors in Y and T, in the range [-1, 1] with -1 and 1 the most conservative choices, and sensitivity_summary in _drlearner.py documents its T argument, matching sensitivity_interval next to it. Signed-off-by: VenishPaneliya <141703684+VenishPaneliya@users.noreply.github.com>
28c108a to
b8f434f
Compare
Yes, it's intentionally the worst case by default and we don't generally expect users to modify it; the point of the sensitivity analysis is to understand how susceptible our estimates are to unmeasured confounders, so typically worst-case confounding is what we expect people to care about. |
sensitivity_summaryandsensitivity_intervaltakec_yandc_t, but all six overloads document the second one asc_d, which they do not accept:dml/causal_forest.pyc_dc_tdml/dml.pyc_dc_tdr/_drlearner.pyc_dc_tThe existing description, "The level of confounding in the treatment. Ranges from 0 to 1.", already matches
c_t, so only the name changes.Two things I deliberately left alone rather than guess at:
rhois undocumented in all six. It has no docstring anywhere in the package — the implementation these forward to,validate/sensitivity_analysis.py, has none either — so I did not invent a description.sensitivity_summaryindr/_drlearner.pydoes not document itsTargument, thoughsensitivity_intervalnext to it does.Happy to add those if you tell me how
rhoshould be described.Docs only, no behaviour change.
ruff checkreports the same before and after.