Skip to content

Commit 589158e

Browse files
Update navbar (automated)
1 parent d4546ac commit 589158e

1,447 files changed

Lines changed: 49643 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

dev/api/Inference/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,7 @@
516516
<!-- NAVBAR END -->
517517

518518

519+
519520
<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 class="is-active"><a class="tocitem" href>Inference</a></li><li><a class="tocitem" href="../Optimisation/">Optimisation</a></li><li><a class="tocitem" href="../Variational/">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>Inference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Inference</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/Inference.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.Inference"><a class="docs-heading-anchor" href="#API:-Turing.Inference">API: <code>Turing.Inference</code></a><a id="API:-Turing.Inference-1"></a><a class="docs-heading-anchor-permalink" href="#API:-Turing.Inference" title="Permalink"></a></h1><article><details class="docstring" open="true"><summary id="Turing.Inference.CSMC"><a class="docstring-binding" href="#Turing.Inference.CSMC"><code>Turing.Inference.CSMC</code></a><span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">CSMC(...)</code></pre><p>Equivalent to <a href="#Turing.Inference.PG"><code>PG</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/00e8f1df90589e4ef8ac9861a6ebb5c1ed0b521f/src/mcmc/particle_mcmc.jl#L275-L279">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Turing.Inference.ESS"><a class="docstring-binding" href="#Turing.Inference.ESS"><code>Turing.Inference.ESS</code></a><span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">ESS</code></pre><p>Elliptical slice sampling algorithm.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; @model function gdemo(x)
520521
m ~ Normal()
521522
x ~ Normal(m, 0.5)

dev/api/Optimisation/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,7 @@
516516
<!-- NAVBAR END -->
517517

518518

519+
519520
<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 class="is-active"><a class="tocitem" href>Optimisation</a></li><li><a class="tocitem" href="../Variational/">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>Optimisation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Optimisation</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/Optimisation.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.Optimisation"><a class="docs-heading-anchor" href="#API:-Turing.Optimisation">API: <code>Turing.Optimisation</code></a><a id="API:-Turing.Optimisation-1"></a><a class="docs-heading-anchor-permalink" href="#API:-Turing.Optimisation" title="Permalink"></a></h1><article><details class="docstring" open="true"><summary id="DynamicPPL.InitFromParams"><a class="docstring-binding" href="#DynamicPPL.InitFromParams"><code>DynamicPPL.InitFromParams</code></a><span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">InitFromParams(
520521
m::ModeResult,
521522
fallback::Union{AbstractInitStrategy,Nothing}=InitFromPrior()

dev/api/RandomMeasures/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,7 @@
516516
<!-- NAVBAR END -->
517517

518518

519+
519520
<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><a class="tocitem" href="../Variational/">Variational </a></li><li class="is-active"><a class="tocitem" href>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>RandomMeasures </a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>RandomMeasures </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/RandomMeasures.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.RandomMeasures"><a class="docs-heading-anchor" href="#API:-Turing.RandomMeasures">API: <code>Turing.RandomMeasures</code></a><a id="API:-Turing.RandomMeasures-1"></a><a class="docs-heading-anchor-permalink" href="#API:-Turing.RandomMeasures" title="Permalink"></a></h1><article><details class="docstring" open="true"><summary id="Turing.RandomMeasures.ChineseRestaurantProcess"><a class="docstring-binding" href="#Turing.RandomMeasures.ChineseRestaurantProcess"><code>Turing.RandomMeasures.ChineseRestaurantProcess</code></a><span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">ChineseRestaurantProcess(rpm, m)</code></pre><p>The <em>Chinese Restaurant Process</em> for random probability measures <code>rpm</code> with counts <code>m</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/00e8f1df90589e4ef8ac9861a6ebb5c1ed0b521f/src/stdlib/RandomMeasures.jl#L48-L52">source</a></section></details></article><article><details class="docstring" open="true"><summary id="Turing.RandomMeasures.DirichletProcess"><a class="docstring-binding" href="#Turing.RandomMeasures.DirichletProcess"><code>Turing.RandomMeasures.DirichletProcess</code></a><span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">DirichletProcess(α)</code></pre><p>The <em>Dirichlet Process</em> with concentration parameter <code>α</code>. Samples from the Dirichlet process can be constructed via the following representations.</p><p><em>Size-Biased Sampling Process</em></p><p class="math-container">\[j_k \sim Beta(1, \alpha) * surplus\]</p><p><em>Stick-Breaking Process</em></p><p class="math-container">\[v_k \sim Beta(1, \alpha)\]</p><p><em>Chinese Restaurant Process</em></p><p class="math-container">\[p(z_n = k | z_{1:n-1}) \propto \begin{cases}
520521
\frac{m_k}{n-1+\alpha}, \text{if} m_k &gt; 0\\
521522
\frac{\alpha}{n-1+\alpha}

dev/api/Variational/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,7 @@
516516
<!-- NAVBAR END -->
517517

518518

519+
519520
<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/00e8f1df90589e4ef8ac9861a6ebb5c1ed0b521f/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/00e8f1df90589e4ef8ac9861a6ebb5c1ed0b521f/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(
520521
[rng::Random.AbstractRNG,]
521522
ldf::DynamicPPL.LogDensityFunction;

dev/api/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,7 @@
516516
<!-- NAVBAR END -->
517517

518518

519+
519520
<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 class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Module-wide-re-exports"><span>Module-wide re-exports</span></a></li><li><a class="tocitem" href="#Individual-exports-and-re-exports"><span>Individual exports and re-exports</span></a></li></ul></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><a class="tocitem" href="Variational/">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 class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</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.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"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h2 id="Module-wide-re-exports"><a class="docs-heading-anchor" href="#Module-wide-re-exports">Module-wide re-exports</a><a id="Module-wide-re-exports-1"></a><a class="docs-heading-anchor-permalink" href="#Module-wide-re-exports" title="Permalink"></a></h2><p>Turing.jl directly re-exports the entire public API of <a href="https://juliastats.org/Distributions.jl">Distributions.jl</a>. Please see its documentation for more details.</p><h2 id="Individual-exports-and-re-exports"><a class="docs-heading-anchor" href="#Individual-exports-and-re-exports">Individual exports and re-exports</a><a id="Individual-exports-and-re-exports-1"></a><a class="docs-heading-anchor-permalink" href="#Individual-exports-and-re-exports" title="Permalink"></a></h2><p>In this API documentation, for the sake of clarity, we have listed the module that actually defines each of the exported symbols. Note, however, that <strong>all</strong> of the following symbols are exported unqualified by Turing. That means, for example, you can just write</p><pre><code class="language-julia hljs">using Turing
520521

521522
@model function my_model() end

0 commit comments

Comments
 (0)