-
Notifications
You must be signed in to change notification settings - Fork 230
Replaces #1437 - additional documentation for filldist and arraydist #1751
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
Merged
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -545,6 +545,41 @@ The `Gibbs` sampler can be used to specify unique automatic differentation backe | |
|
|
||
| For more details of compositional sampling in Turing.jl, please check the corresponding [paper](http://proceedings.mlr.press/v84/ge18b.html). | ||
|
|
||
| ### Working with filldist and arraydist | ||
|
|
||
| Turing provides `filldist(dist::Distribution, n::Int)` and `arraydist(dists::AbstractVector{<:Distribution})` as a simplified interface to construct product distributions, e.g., to model a set of variables that share the same structure but vary by group. | ||
|
|
||
| #### Constructing product distributions with filldist | ||
|
|
||
| The function `filldist` provides a general interface to construct product distributions over distributions of the same type and parameterisation. | ||
| Note that in contrast to the product distribution interface provided by Distributions.jl (`Product`), `filldist` supports product distributions over univariate or multivariate distributions. | ||
trappmartin marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Example usage: | ||
|
|
||
| ```julia | ||
| @model function demo(x, g) | ||
| k = length(unique(g)) | ||
| a ~ filldist(Exponential(), k) # = Product(fill(Exponential(), k)) | ||
| mu = a[g] | ||
| x .~ Normal.(mu) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Wouldn't an |
||
| end | ||
| ``` | ||
|
|
||
| #### Constructing product distributions with arraydist | ||
|
|
||
| The function `arraydist` provides a general interface to construct product distributions over distributions of varying type and parameterisation. | ||
| Note that in contrast to the product distribution interface provided by Distributions.jl (`Product`), `arraydist` supports product distributions over univariate or multivariate distributions. | ||
|
|
||
| Example usage: | ||
|
|
||
| ```julia | ||
| @model function demo(x, g) | ||
| k = length(unique(g)) | ||
| a ~ arraydist([Exponential(i) for i in 1:k]) | ||
| mu = a[g] | ||
| x .~ Normal.(mu) | ||
| end | ||
| ``` | ||
|
|
||
| ### Working with MCMCChains.jl | ||
|
|
||
|
|
@@ -638,3 +673,4 @@ In all other cases progress logs are displayed with | |
| [TerminalLoggers.jl](https://github.com/c42f/TerminalLoggers.jl). Alternatively, | ||
| if you provide a custom visualization backend, Turing uses it instead of the | ||
| default backend. | ||
|
|
||
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.
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.
Just a heads up, rather sooner than later they will be integrated and generalized in Distributions: JuliaStats/Distributions.jl#1391 I am working on a PR to DistributionsAD that would fix the errors mentioned in the last comments; then we can switch
product_distributioncompletely fromProducttoProductDistribution.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.
Lovely improvements - I look forward to the new Distributions release!