pyro-ppl / numpyro / 33474432102

93%

push

github

Rename Predictive's exclude_deterministic to condition_deterministic (#2259)

Issue #2086 reported that Predictive.exclude_deterministic reads as if
it controls which sites are returned, when it actually controls whether
deterministic sites in posterior_samples are conditioned on during
substitution. Maintainers converged on the clearer name
condition_deterministic (suggested by kylejcaron, endorsed by
juanitorduz).

- new keyword condition_deterministic (default False, same behaviour
  as the old default exclude_deterministic=True)
- exclude_deterministic kwarg still accepted with a FutureWarning;
  passing both raises ValueError
- exclude_deterministic attribute kept as a deprecated property
  (getter and setter) so existing code that flips it keeps working
- docstring now explains what the flag actually does, points to
  return_sites for output filtering, and documents why conditioning
  on deterministic sites is off by default (shape/staleness bugs,
  see #1772)
- tests for the deprecation path, both-kwargs error, and default

Closes #2086

Co-authored-by: Agi-Asi <206806952+Agi-Asi@users.noreply.github.com>

16 of 16 new or added lines in 1 file covered. (100.0%)

14761 of 15983 relevant lines covered (92.35%)

1.69 hits per line