Skip to content

Commit

Permalink
Permit dot call (like Distributions.Normal) to be used in model def…
Browse files Browse the repository at this point in the history
…inition (#237)

The motivation for the PR is initially to allow the use
[`product_distribution`](https://juliastats.org/Distributions.jl/stable/multivariate/#Distributions.product_distribution)
in JuliaBUGS model. By writing

```julia
@bugs begin
    x[1:2] ~ Distributions.product_distribution(fill(Normal(), 2))
end
```

It also enables

```julia
julia> foo(x) = x + 1
foo (generic function with 1 method)

julia> model_def = @bugs begin
           a = Main.foo(b)
       end
quote
    a = Main.foo(b)
end

julia> compile(model_def, (;b=2))
BUGSModel (parameters are in transformed (unconstrained) space, with dimension 0):

  Model parameters:

  Variable sizes and types:
    a: type = Int64
    b: type = Int64
```

i.e., an easier way to introduce external functions into JuliaBUGS. 

This can't fully replace `@register_primitive` yet, because using `Main`
module is relying on Julia runtime behavior and not very intuitive.
Examples:

```julia
julia> module TestModule
           bar(x) = x + 1
       end
Main.TestModule

julia> model_def = @bugs begin
           a = TestModule.bar(b)
       end
quote
    a = TestModule.bar(b)
end

julia> compile(model_def, (; b = 1))
ERROR: UndefVarError: `TestModule` not defined in `JuliaBUGS`
...
```

one would need to do 

```julia
julia> model_def = @bugs begin
           a = Main.TestModule.bar(b)
       end
quote
    a = Main.TestModule.bar(b)
end
```

also

```julia
julia> @testset "t" begin
           foo1(x) = x + 1
           model_def = @bugs begin
               a = Main.foo1(b)
           end
           compile(model_def, (; b= 1))
       end
t: Error During Test at REPL[18]:1
  Got exception outside of a @test
  UndefVarError: `foo1` not defined in `Main`
...
```
  • Loading branch information
sunxd3 authored Nov 16, 2024
1 parent 41620db commit 26ef662
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "JuliaBUGS"
uuid = "ba9fb4c0-828e-4473-b6a1-cd2560fee5bf"
version = "0.6.5"
version = "0.7.0"

[deps]
AbstractMCMC = "80f14c24-f653-4e6a-9b94-39d6b0f70001"
Expand Down
2 changes: 2 additions & 0 deletions src/parser/bugs_macro.jl
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ function bugs_expression(expr, line_num)
error(
"Keyword argument syntax is not supported in BUGS, error at $line_num: $(expr)"
)
elseif Meta.isexpr(expr, :.)
return expr
else
error("Invalid expression at $line_num: `$expr`")
end
Expand Down
8 changes: 8 additions & 0 deletions test/compile.jl
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,11 @@ end
@test AbstractPPL.get(model_init_1.evaluation_env, @varname(beta)) == 1
end
end

@testset "dot call" begin
model_def = @bugs begin
x[1:2] ~ Distributions.product_distribution(fill(Distributions.Normal(0, 1), 2))
end
model = compile(model_def, (;))
@test model.evaluation_env.x isa Vector{Float64}
end

2 comments on commit 26ef662

@sunxd3
Copy link
Member Author

@sunxd3 sunxd3 commented on 26ef662 Nov 16, 2024

Choose a reason for hiding this comment

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

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/119572

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.7.0 -m "<description of version>" 26ef66241c4f8748a95dc990922046ad812a4bea
git push origin v0.7.0

Please sign in to comment.