-
Notifications
You must be signed in to change notification settings - Fork 227
Update to the [email protected] interface #2506
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
base: breaking
Are you sure you want to change the base?
Conversation
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…nto update_advancedvi
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…nto update_advancedvi
@Red-Portal, can you fix the tests before I take a look? |
@yebai I marked the PR as a draft so that we can first agree on an interface, and then I flesh out the implementation and the tests. Do we wish we proceed in another way? |
Let's address the interface later or in a separate PR since that might require more discussions. For this PR, let's try to keep the VI interface non-breaking where possible. |
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
I'm confused at the CI failure of |
@Red-Portal, hopefully if you merge |
@yebai I think the code is good to go on my end. How should we proceed in terms of documentation? Is this tutorial all that I need to update? |
I think so, cc @penelopeysm, who might know other related docs pages requiring update. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main TuringLang docs can't be edited until you've released a version of Turing that contains these fixes, so that's going to be a later PR.
First of all the API docs in docs/src/api.md
will need to be edited. This is pretty much just a table that lists the identifiers that Turing re-exports, plus a link to the original docs (in this case AdvancedVI docs).
Then, this should be a minor version release, right? For Turing and DynamicPPL, we keep a breaking
branch that we merge breaking changes into - the point is to aggregate breaking changes so that we don't have an overly frequent stream of minor releases.
Could you change the base branch of this PR to point to that, and edit the changelog accordingly? It might be nice to give a bit of a summary of what's new in AdvancedVI 0.4, although feel free to just point people to the API docs for the details.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This PR aims to update Turing's
Variational
module to match AdvancedVI's new interface starting fromv0.3
. I will try not to change the interface too much, but given the new features inAdvancedVI
, I think breaking changes will be inevitable. Though the focus will be to provide a good default setting rather than to expose all the features.Currently proposed interface:
Closes #2507
Closes #2508
Closes #2430