AbstractPPL 0.11; change prefixing behaviour

Author: penelopeysm

HISTORY.md

@@ -1,5 +1,39 @@
 # DynamicPPL Changelog
 
+## 0.36.0
+
+**Breaking changes**
+
+### VarName prefixing behaviour
+
+Previously, a prefixed varname would concatenate its prefixes with the symbol.
+Now, a prefixed varname creates a new field on the prefix.
+This is rather abstract, so it's best explained through an example.
+Consider this model and submodel:
+
+```julia
+using DynamicPPL, Distributions
+@model inner() = x ~ Normal()
+@model outer() = a ~ to_submodel(inner())
+```
+
+In previous versions, the inner variable `x` would be saved as `a.x`.
+However, this was represented as a single symbol `Symbol("a.x")`:
+
+```julia
+julia> dump(keys(VarInfo(outer()))[1])
+VarName{Symbol("a.x"), typeof(identity)}
+  optic: identity (function of type typeof(identity))
+```
+
+Now, the inner variable is stored as a field `x` on the VarName `a`:
+
+```julia
+julia> dump(keys(VarInfo(outer()))[1])
+VarName{:a, Accessors.PropertyLens{:x}}
+  optic: Accessors.PropertyLens{:x} (@o _.x)
+```
+
 ## 0.35.5
 
 Several internal methods have been removed:

Project.toml

@@ -44,7 +44,7 @@ DynamicPPLMooncakeExt = ["Mooncake"]
 [compat]
 ADTypes = "1"
 AbstractMCMC = "5"
-AbstractPPL = "0.10.1"
+AbstractPPL = "0.11"
 Accessors = "0.1"
 BangBang = "0.4.1"
 Bijectors = "0.13.18, 0.14, 0.15"

src/DynamicPPL.jl

@@ -39,7 +39,7 @@ import Base:
     keys,
     haskey
 
-import AbstractPPL: predict
+import AbstractPPL: predict, prefix
 
 # VarInfo
 export AbstractVarInfo,

src/contexts.jl

@@ -260,21 +260,8 @@ function setchildcontext(::PrefixContext{Prefix}, child) where {Prefix}
     return PrefixContext{Prefix}(child)
 end
 
-const PREFIX_SEPARATOR = Symbol(".")
-
-@generated function PrefixContext{PrefixOuter}(
-    context::PrefixContext{PrefixInner}
-) where {PrefixOuter,PrefixInner}
-    return :(PrefixContext{$(QuoteNode(Symbol(PrefixOuter, PREFIX_SEPARATOR, PrefixInner)))}(
-        context.context
-    ))
-end
-
 function prefix(ctx::PrefixContext{Prefix}, vn::VarName{Sym}) where {Prefix,Sym}
-    vn_prefixed_inner = prefix(childcontext(ctx), vn)
-    return VarName{Symbol(Prefix, PREFIX_SEPARATOR, getsym(vn_prefixed_inner))}(
-        getoptic(vn_prefixed_inner)
-    )
+    return AbstractPPL.prefix(vn, VarName{Symbol(Prefix)}())
 end
 prefix(ctx::AbstractContext, vn::VarName) = prefix(NodeTrait(ctx), ctx, vn)
 prefix(::IsLeaf, ::AbstractContext, vn::VarName) = vn

src/model.jl

@@ -243,7 +243,7 @@ julia> model() ≠ 1.0
 true
 
 julia> # To condition the variable inside `demo_inner` we need to refer to it as `inner.m`.
-       conditioned_model = model | (var"inner.m" = 1.0, );
+       conditioned_model = model | (@varname(inner.m) => 1.0, );
 
 julia> conditioned_model()
 1.0
@@ -255,15 +255,6 @@ julia> conditioned_model_fail()
 ERROR: ArgumentError: `~` with a model on the right-hand side of an observe statement is not supported
 [...]
 ```
-
-And similarly when using `Dict`:
-
-```jldoctest condition
-julia> conditioned_model_dict = model | (@varname(var"inner.m") => 1.0);
-
-julia> conditioned_model_dict()
-1.0
-```
 """
 function AbstractPPL.condition(model::Model, values...)
     # Positional arguments - need to handle cases carefully
@@ -583,7 +574,7 @@ julia> model = demo_outer();
 julia> model() ≠ 1.0
 true
 
-julia> fixed_model = fix(model, var"inner.m" = 1.0, );
+julia> fixed_model = fix(model, (@varname(inner.m) => 1.0, ));
 
 julia> fixed_model()
 1.0
@@ -599,24 +590,9 @@ julia> fixed_model()
 2.0
 ```
 
-And similarly when using `Dict`:
-
-```jldoctest fix
-julia> fixed_model_dict = fix(model, @varname(var"inner.m") => 1.0);
-
-julia> fixed_model_dict()
-1.0
-
-julia> fixed_model_dict = fix(model, @varname(inner) => 2.0);
-
-julia> fixed_model_dict()
-2.0
-```
-
 ## Difference from `condition`
 
-A very similar functionality is also provided by [`condition`](@ref) which,
-not surprisingly, _conditions_ variables instead of fixing them. The only
+A very similar functionality is also provided by [`condition`](@ref). The only
 difference between fixing and conditioning is as follows:
 - `condition`ed variables are considered to be observations, and are thus
   included in the computation [`logjoint`](@ref) and [`loglikelihood`](@ref),
@@ -798,11 +774,11 @@ julia> fixed(cm)
 julia> # Since we fixed on `m`, not `a.m` as it will appear after prefixed,
        # `a.m` is treated as a random variable.
        keys(VarInfo(cm))
-1-element Vector{VarName{Symbol("a.m"), typeof(identity)}}:
+1-element Vector{VarName{:a, Accessors.PropertyLens{:m}}}:
  a.m
 
 julia> # If we instead fix on `a.m`, `m` in the model will be considered an observation.
-       cm = fix(contextualize(m, PrefixContext{:a}(fix(var"a.m"=1.0))), x=100.0);
+       cm = fix(contextualize(m, PrefixContext{:a}(fix(@varname(a.m) => 1.0,))), x=100.0);
 
 julia> fixed(cm).x
 100.0

src/submodel_macro.jl

@@ -96,10 +96,10 @@ julia> vi = VarInfo(demo2(missing, missing, 0.4));
 │   caller = ip:0x0
 └ @ Core :-1
 
-julia> @varname(var"sub1.x") in keys(vi)
+julia> @varname(sub1.x) in keys(vi)
 true
 
-julia> @varname(var"sub2.x") in keys(vi)
+julia> @varname(sub2.x) in keys(vi)
 true
 ```
 
@@ -116,9 +116,9 @@ false
 We can check that the log joint probability of the model accumulated in `vi` is correct:
 
 ```jldoctest submodelprefix
-julia> sub1_x = vi[@varname(var"sub1.x")];
+julia> sub1_x = vi[@varname(sub1.x)];
 
-julia> sub2_x = vi[@varname(var"sub2.x")];
+julia> sub2_x = vi[@varname(sub2.x)];
 
 julia> logprior = logpdf(Normal(), sub1_x) + logpdf(Normal(), sub2_x);
 
@@ -157,7 +157,7 @@ julia> # Automatically determined from `a`.
        @model submodel_prefix_true() = @submodel prefix=true a = inner()
 submodel_prefix_true (generic function with 2 methods)
 
-julia> @varname(var"a.x") in keys(VarInfo(submodel_prefix_true()))
+julia> @varname(a.x) in keys(VarInfo(submodel_prefix_true()))
 ┌ Warning: `@submodel model` and `@submodel prefix=... model` are deprecated; see `to_submodel` for the up-to-date syntax.
 │   caller = ip:0x0
 └ @ Core :-1
@@ -167,7 +167,7 @@ julia> # Using a static string.
        @model submodel_prefix_string() = @submodel prefix="my prefix" a = inner()
 submodel_prefix_string (generic function with 2 methods)
 
-julia> @varname(var"my prefix.x") in keys(VarInfo(submodel_prefix_string()))
+julia> @varname(var"my prefix".x) in keys(VarInfo(submodel_prefix_string()))
 ┌ Warning: `@submodel model` and `@submodel prefix=... model` are deprecated; see `to_submodel` for the up-to-date syntax.
 │   caller = ip:0x0
 └ @ Core :-1
@@ -177,7 +177,7 @@ julia> # Using string interpolation.
        @model submodel_prefix_interpolation() = @submodel prefix="\$(nameof(inner()))" a = inner()
 submodel_prefix_interpolation (generic function with 2 methods)
 
-julia> @varname(var"inner.x") in keys(VarInfo(submodel_prefix_interpolation()))
+julia> @varname(inner.x) in keys(VarInfo(submodel_prefix_interpolation()))
 ┌ Warning: `@submodel model` and `@submodel prefix=... model` are deprecated; see `to_submodel` for the up-to-date syntax.
 │   caller = ip:0x0
 └ @ Core :-1
@@ -187,7 +187,7 @@ julia> # Or using some arbitrary expression.
        @model submodel_prefix_expr() = @submodel prefix=1 + 2 a = inner()
 submodel_prefix_expr (generic function with 2 methods)
 
-julia> @varname(var"3.x") in keys(VarInfo(submodel_prefix_expr()))
+julia> @varname(var"3".x) in keys(VarInfo(submodel_prefix_expr()))
 ┌ Warning: `@submodel model` and `@submodel prefix=... model` are deprecated; see `to_submodel` for the up-to-date syntax.
 │   caller = ip:0x0
 └ @ Core :-1

test/Project.toml

@@ -32,7 +32,7 @@ Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
 [compat]
 ADTypes = "1"
 AbstractMCMC = "5"
-AbstractPPL = "0.10.1"
+AbstractPPL = "0.11"
 Accessors = "0.1"
 Aqua = "0.8"
 Bijectors = "0.15.1"

test/compiler.jl

@@ -481,8 +481,8 @@ module Issue537 end
         m = demo_useval(missing, missing)
         vi = VarInfo(m)
         ks = keys(vi)
-        @test VarName{Symbol("sub1.x")}() ∈ ks
-        @test VarName{Symbol("sub2.x")}() ∈ ks
+        @test @varname(sub1.x) ∈ ks
+        @test @varname(sub2.x) ∈ ks
         @test @varname(z) ∈ ks
         @test abs(mean([VarInfo(m)[@varname(z)] for i in 1:10]) - 100) ≤ 10
 
@@ -514,8 +514,9 @@ module Issue537 end
         m = demo(ys)
         vi = VarInfo(m)
 
-        for k in [:α, :μ, :σ, Symbol("ar1_1.η"), Symbol("ar1_2.η")]
-            @test VarName{k}() ∈ keys(vi)
+        for vn in
+            [@varname(α), @varname(μ), @varname(σ), @varname(ar1_1.η), @varname(ar1_2.η)]
+            @test vn ∈ keys(vi)
         end
     end
 

test/contexts.jl

@@ -39,17 +39,6 @@ end
 Base.IteratorSize(::Type{<:AbstractContext}) = Base.SizeUnknown()
 Base.IteratorEltype(::Type{<:AbstractContext}) = Base.EltypeUnknown()
 
-"""
-    remove_prefix(vn::VarName)
-
-Return `vn` but now with the prefix removed.
-"""
-function remove_prefix(vn::VarName)
-    return VarName{Symbol(split(string(vn), string(DynamicPPL.PREFIX_SEPARATOR))[end])}(
-        getoptic(vn)
-    )
-end
-
 @testset "contexts.jl" begin
     child_contexts = [DefaultContext(), PriorContext(), LikelihoodContext()]
 

test/deprecated.jl

@@ -31,7 +31,7 @@
             @test outer()() isa Tuple{Float64,Float64}
             vi = VarInfo(outer())
             @test @varname(x) in keys(vi)
-            @test @varname(var"sub.x") in keys(vi)
+            @test @varname(sub.x) in keys(vi)
         end
 
         @testset "logp is still accumulated properly" begin