Added navbar and removed insert_navbar.sh

index.html

@@ -1,2 +1,3 @@
 <!--This file is automatically generated by Documenter.jl-->
 <meta http-equiv="refresh" content="0; url=./stable/"/>
+

previews/PR2328/api/Inference/index.html

@@ -457,6 +457,7 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <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></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/master/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 class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Turing.Inference.CSMC" href="#Turing.Inference.CSMC"><code>Turing.Inference.CSMC</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><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/2c7c1a27c269856390abd91bb3b045b3d872fe27/src/mcmc/particle_mcmc.jl#L227-L231">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Turing.Inference.ESS" href="#Turing.Inference.ESS"><code>Turing.Inference.ESS</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><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)
            m ~ Normal()
            x ~ Normal(m, 0.5)

previews/PR2328/api/Optimisation/index.html

@@ -457,6 +457,7 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <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></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/master/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 class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="SciMLBase.OptimizationProblem-Tuple{LogDensityFunction{V, M, C} where {M&lt;:DynamicPPL.Model, C&lt;:Turing.Optimisation.OptimizationContext, V&lt;:DynamicPPL.VarInfo}, Any, Any}" href="#SciMLBase.OptimizationProblem-Tuple{LogDensityFunction{V, M, C} where {M&lt;:DynamicPPL.Model, C&lt;:Turing.Optimisation.OptimizationContext, V&lt;:DynamicPPL.VarInfo}, Any, Any}"><code>SciMLBase.OptimizationProblem</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">OptimizationProblem(log_density::OptimLogDensity, adtype, constraints)</code></pre><p>Create an <code>OptimizationProblem</code> for the objective function defined by <code>log_density</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/2c7c1a27c269856390abd91bb3b045b3d872fe27/src/optimisation/Optimisation.jl#L413-L417">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Turing.Optimisation.MAP" href="#Turing.Optimisation.MAP"><code>Turing.Optimisation.MAP</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MAP &lt;: ModeEstimator</code></pre><p>Concrete type for maximum a posteriori estimation. Only used for the Optim.jl interface.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/2c7c1a27c269856390abd91bb3b045b3d872fe27/src/optimisation/Optimisation.jl#L39-L43">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Turing.Optimisation.MLE" href="#Turing.Optimisation.MLE"><code>Turing.Optimisation.MLE</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">MLE &lt;: ModeEstimator</code></pre><p>Concrete type for maximum likelihood estimation. Only used for the Optim.jl interface.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/2c7c1a27c269856390abd91bb3b045b3d872fe27/src/optimisation/Optimisation.jl#L32-L36">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Turing.Optimisation.ModeEstimationConstraints" href="#Turing.Optimisation.ModeEstimationConstraints"><code>Turing.Optimisation.ModeEstimationConstraints</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ModeEstimationConstraints</code></pre><p>A struct that holds constraints for mode estimation problems.</p><p>The fields are the same as possible constraints supported by the Optimization.jl: <code>ub</code> and <code>lb</code> specify lower and upper bounds of box constraints. <code>cons</code> is a function that takes the parameters of the model and returns a list of derived quantities, which are then constrained by the lower and upper bounds set by <code>lcons</code> and <code>ucons</code>. We refer to these as generic constraints. Please see the documentation of <a href="https://docs.sciml.ai/Optimization/stable/">Optimization.jl</a> for more details.</p><p>Any of the fields can be <code>nothing</code>, disabling the corresponding constraints.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/2c7c1a27c269856390abd91bb3b045b3d872fe27/src/optimisation/Optimisation.jl#L341-L354">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Turing.Optimisation.ModeEstimator" href="#Turing.Optimisation.ModeEstimator"><code>Turing.Optimisation.ModeEstimator</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ModeEstimator</code></pre><p>An abstract type to mark whether mode estimation is to be done with maximum a posteriori (MAP) or maximum likelihood estimation (MLE). This is only needed for the Optim.jl interface.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/TuringLang/Turing.jl/blob/2c7c1a27c269856390abd91bb3b045b3d872fe27/src/optimisation/Optimisation.jl#L24-L29">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Turing.Optimisation.ModeResult" href="#Turing.Optimisation.ModeResult"><code>Turing.Optimisation.ModeResult</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">ModeResult{
     V&lt;:NamedArrays.NamedArray,
     M&lt;:NamedArrays.NamedArray,

previews/PR2328/api/index.html

@@ -457,6 +457,7 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <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></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/master/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 the following packages:</p><ul><li><a href="https://juliastats.org/Distributions.jl">Distributions.jl</a></li><li><a href="https://turinglang.org/MCMCChains.jl">MCMCChains.jl</a></li><li><a href="https://turinglang.org/AbstractMCMC.jl">AbstractMCMC.jl</a></li><li><a href="https://turinglang.org/Bijectors.jl">Bijectors.jl</a></li><li><a href="https://github.com/TuringLang/Libtask.jl">Libtask.jl</a></li></ul><p>Please see the individual packages for their documentation.</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><strong>All</strong> of the following symbols are exported unqualified by Turing, even though the documentation suggests that many of them are qualified. That means, for example, you can just write</p><pre><code class="language-julia hljs">using Turing
 
 @model function my_model() end

previews/PR2328/index.html

@@ -457,5 +457,6 @@
     });
 </script>
 <!-- NAVBAR END -->
+
 <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 class="is-active"><a class="tocitem" href>Home</a></li><li><a class="tocitem" href="api/">API</a></li><li><span class="tocitem">Submodule APIs</span><ul><li><a class="tocitem" href="api/Inference/">Inference</a></li><li><a class="tocitem" href="api/Optimisation/">Optimisation</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>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</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/master/docs/src/index.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="Turing.jl"><a class="docs-heading-anchor" href="#Turing.jl">Turing.jl</a><a id="Turing.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Turing.jl" title="Permalink"></a></h1><p>This site contains the API documentation for the identifiers exported by Turing.jl.</p><p>If you are looking for usage examples and guides, please visit <a href="https://turinglang.org/docs">https://turinglang.org/docs</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 18 December 2024 18:47">Wednesday 18 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>