Make it safer to use factor statements in guides #2952
Merged
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.
Blocking #2948
It has always been dangerous to use
pyro.factor
statements in guides #2829, because the guide doesn't know whether the factor arose from reparameterized or non-reparameterized sampling. This PR adds ahas_rsample
kwarg topyro.factor
and the underlyingUnit
distribution. Thehas_rsample
need not be specified forpyro.factor
statements in models, but is now required when usingpyro.factor
statements in guides. While this does cause some backwards incompatibility, I believe the likely small breakage will be worth introducing, so as to avoid silent errors (I've just spent half a week hunting down a bug in my own code due to this).Tested