Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to make Predictive behavior more clear #1850

Merged
merged 3 commits into from
Sep 6, 2024

Conversation

tomwallis
Copy link
Contributor

This PR addresses this issue, improving the docs for how the Predictive class is expected to function. In particular, I try to make it more clear that the observations should be set to None to explicitly make prior or posterior predictions.

I updated the docstring for the class itself, and also two of the example ipynbs.

In the docstring files there are also some black import re-orderings.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Member

@fehiepsi fehiepsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @tomwallis!


import jax
import jax.numpy as jnp
import numpy as np
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you revert the order of those imports? This seems to make CI failing.

@fehiepsi
Copy link
Member

fehiepsi commented Sep 5, 2024

@tomwallis We are going to make a new patch release soon. Do you want to incorporate this change in the release?

@tomwallis
Copy link
Contributor Author

Sorry @fehiepsi I was on holiday then too busy. Hopefully this fixes the issue.

@fehiepsi fehiepsi merged commit bb7767e into pyro-ppl:master Sep 6, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants