Add page on models and varinfos, part 1 #663
                
     Open
            
            
          
  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.