Add page on models and varinfos, part 1#663
Merged
penelopeysm merged 7 commits intomainfrom Nov 4, 2025
Merged
Conversation
3ade052 to
1e3f53f
Compare
Contributor
|
Preview the changes: https://turinglang.org/docs/pr-previews/663 |
mhauru
approved these changes
Oct 29, 2025
Member
mhauru
left a comment
There was a problem hiding this comment.
A tiny optional comma-move, otherwise I'm happy to merge. Maybe hold off for a few days in case someone else wants to comment.
I have many things I would like to add to this, but I think it makes sense to expand later once the current VarInfo overhaul is done.
Member
Author
Feel free to tack on to #664 / a new issue! |
Co-authored-by: Markus Hauru <mhauru@turing.ac.uk>
Member
Author
|
Merging, any other suggestions from anyone, please feel free to open a new PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #660.
Preview @ https://turinglang.org/docs/pr-previews/663/developers/models/varinfo-overview/
I tried very hard to avoid going into untyped vs typed VarInfo, but it proved to be impossible to fully explain this without mentioning that, because some things simply can't be done with typed VarInfo e.g. TuringLang/DynamicPPL.jl#1062.
However, it is self-contained at the very end of the page and for the most part, we only cover four things:
VarInfo(model)evaluate!!init!!unflattenwhich mostly lines up with my plans from #660.
I didn't make any mention of
Metadatathe struct, so even if we replace Metadata with VNV, the considerations described here should still hold.This is not future-proof against a complete overhaul of VarInfo, but I assume that will take a while and in my opinion it's a Good Thing to have some docs in place now.