<div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">Turing</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><a class="tocitem" href="../">API</a></li><li><span class="tocitem">Submodule APIs</span><ul><li><a class="tocitem" href="../Inference/">Inference</a></li><li><a class="tocitem" href="../Optimisation/">Optimisation</a></li><li class="is-active"><a class="tocitem" href>Variational </a></li><li><a class="tocitem" href="../RandomMeasures/">RandomMeasures </a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Submodule APIs</a></li><li class="is-active"><a href>Variational </a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Variational </a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/TuringLang/Turing.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/TuringLang/Turing.jl/blob/main/docs/src/api/Variational.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="API:-Turing.Variational"><a class="docs-heading-anchor" href="#API:-Turing.Variational">API: <code>Turing.Variational</code></a><a id="API:-Turing.Variational-1"></a><a class="docs-heading-anchor-permalink" href="#API:-Turing.Variational" title="Permalink"></a></h1><article><details class="docstring" open="true"><summary id="Turing.Variational.VIResult"><a class="docstring-binding" href="#Turing.Variational.VIResult"><code>Turing.Variational.VIResult</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">VIResult(ldf, q, info, state)</code></pre><ul><li><code>ldf</code>: A <a href="https://turinglang.org/DynamicPPL.jl/stable/api/#DynamicPPL.LogDensityFunction-Tuple%7BModel%2C%20Any%2C%20VarNamedTuple%7D"><code>DynamicPPL.LogDensityFunction</code></a> corresponding to the target model (the original model can be accessed as <code>ldf.model</code>). If the VI process was run in unconstrained space, this LogDensityFunction will also be in unconstrained space.</li><li><code>q</code>: Output variational distribution of <code>algorithm</code>. Note that, as above, this will typically also be in unconstrained space.</li><li><code>state</code>: Collection of states used by <code>algorithm</code>. This can be used to resume from a past call to <code>vi</code>.</li><li><code>info</code>: Information generated while executing <code>algorithm</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/7c3a2a51d63ee2382531c112871f3b1bcc57c62e/src/variational/Variational.jl#L276-L287">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Base.rand-Tuple{Random.AbstractRNG, Turing.Variational.VIResult, Vararg{Integer}}"><a class="docstring-binding" href="#Base.rand-Tuple{Random.AbstractRNG, Turing.Variational.VIResult, Vararg{Integer}}"><code>Base.rand</code></a> — <span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">Base.rand(rng::Random.AbstractRNG, res::VIResult, sz...)</code></pre><p>Draw a sample, or array of samples, from the variational distribution <code>q</code> in <code>res</code>. Each sample is a <a href="https://turinglang.org/DynamicPPL.jl/stable/api/#DynamicPPL.VarNamedTuples.VarNamedTuple"><code>DynamicPPL.VarNamedTuple</code></a> containing raw parameter values.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/7c3a2a51d63ee2382531c112871f3b1bcc57c62e/src/variational/Variational.jl#L312-L318">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Turing.Variational.q_fullrank_gaussian-Tuple{Random.AbstractRNG, LogDensityFunction}"><a class="docstring-binding" href="#Turing.Variational.q_fullrank_gaussian-Tuple{Random.AbstractRNG, LogDensityFunction}"><code>Turing.Variational.q_fullrank_gaussian</code></a> — <span class="docstring-category">Method</span></summary><section><div><pre><code class="language-julia hljs">q_fullrank_gaussian(
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments