build based on 8ac7bf4

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-25T12:11:08","documenter_version":"1.6.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-25T12:15:53","documenter_version":"1.6.0"}}

dev/api/index.html

@@ -7,12 +7,12 @@
       checkpoint_history = 1,
       show_progressbar::Bool = !is_logging(stderr),
       show_checkpoint = is_logging(stderr) ? 100 : Inf,
-      kwargs...)</code></pre><p><strong>Simulated Annealing Approximate Bayesian Inference Algorithm</strong></p><p><strong>Arguments</strong></p><ul><li><code>f_dist</code>: Function that one or more distances between data and a random sample from the likelihood. The first argument must be the parameter vector.</li><li><code>prior</code>: A <code>Distribution</code> defining the prior.</li><li><code>args...</code>: Further arguments passed to <code>f_dist</code></li><li><code>n_particles</code>: Desired number of particles.</li><li><code>n_simulation</code>: maximal number of simulations from <code>f_dist</code>.</li><li><code>v = 1.0</code>: Tuning parameter for XXX</li><li><code>β = 0.8</code>: Tuning parameter for XXX</li><li><code>δ = 0.1</code>: Tuning parameter for XXX</li><li><code>type = :multi</code>: Choose algorithm, either <code>:multi</code>, or <code>:hybrid</code></li><li><code>resample</code>: After how many accepted population updates?</li><li><code>checkpoint_history = 1</code>: every how many population updates distances and epsilons are stored</li><li><code>show_progressbar::Bool = !is_logging(stderr)</code>: defaults to <code>true</code> for interactive use.</li><li><code>show_checkpoint::Int = 100</code>: every how many population updates algorithm state is displayed.                               By default disabled for for interactive use.</li><li><code>kwargs...</code>: Further arguments passed to <code>f_dist</code>`</li></ul><p><strong>Return</strong></p><ul><li>An object of type <code>SABCresult</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Eawag-SIAM/SimulatedAnnealingABC.jl/blob/cda55d4c5ae1c5fa4d7c364cac478c6fbd87b824/src/SimulatedAnnealingABC.jl#L411-L444">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="SimulatedAnnealingABC.update_population!" href="#SimulatedAnnealingABC.update_population!"><code>SimulatedAnnealingABC.update_population!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">update_population!(population_state::SABCresult,
+      kwargs...)</code></pre><p><strong>Simulated Annealing Approximate Bayesian Inference Algorithm</strong></p><p><strong>Arguments</strong></p><ul><li><code>f_dist</code>: Function that one or more distances between data and a random sample from the likelihood. The first argument must be the parameter vector.</li><li><code>prior</code>: A <code>Distribution</code> defining the prior.</li><li><code>args...</code>: Further arguments passed to <code>f_dist</code></li><li><code>n_particles</code>: Desired number of particles.</li><li><code>n_simulation</code>: maximal number of simulations from <code>f_dist</code>.</li><li><code>v = 1.0</code>: Tuning parameter for XXX</li><li><code>β = 0.8</code>: Tuning parameter for XXX</li><li><code>δ = 0.1</code>: Tuning parameter for XXX</li><li><code>type = :hybrid</code>: Choose algorithm, either <code>:multi</code>, or <code>:hybrid</code></li><li><code>resample</code>: After how many accepted population updates?</li><li><code>checkpoint_history = 1</code>: every how many population updates distances and epsilons are stored</li><li><code>show_progressbar::Bool = !is_logging(stderr)</code>: defaults to <code>true</code> for interactive use.</li><li><code>show_checkpoint::Int = 100</code>: every how many population updates algorithm state is displayed.                               By default disabled for for interactive use.</li><li><code>kwargs...</code>: Further arguments passed to <code>f_dist</code>`</li></ul><p><strong>Return</strong></p><ul><li>An object of type <code>SABCresult</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Eawag-SIAM/SimulatedAnnealingABC.jl/blob/8ac7bf40665aa20cd7e76a9adbbd9b9d9155a5ee/src/SimulatedAnnealingABC.jl#L411-L444">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="SimulatedAnnealingABC.update_population!" href="#SimulatedAnnealingABC.update_population!"><code>SimulatedAnnealingABC.update_population!</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">update_population!(population_state::SABCresult,
                    f_dist, prior, args...;
                    n_simulation,
                    v=1.0, β=0.8, δ=0.1,
                    resample = 2*length(population_state.population),
                    checkpoint_history = 1,
                    show_progressbar::Bool = !is_logging(stderr),
                    show_checkpoint = is_logging(stderr) ? 100 : Inf,
-                   kwargs...)</code></pre><p>Updates particles with <code>n_simulation</code> and applies importance sampling if needed. Modifies <code>population_state</code>.</p><p><strong>Arguments</strong></p><p>See docstring for <code>sabc</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Eawag-SIAM/SimulatedAnnealingABC.jl/blob/cda55d4c5ae1c5fa4d7c364cac478c6fbd87b824/src/SimulatedAnnealingABC.jl#L249-L268">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="SimulatedAnnealingABC.SABCresult" href="#SimulatedAnnealingABC.SABCresult"><code>SimulatedAnnealingABC.SABCresult</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><p>Holds results from a SABC run with fields:</p><ul><li><code>population</code>: vector of parameter samples from the approximate posterior</li><li><code>u</code>: transformed distances</li><li><code>ρ</code>: distances</li><li><code>state</code>: state of algorithm</li></ul><p>The history of ϵ can be accessed with the field <code>state.ϵ_history</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Eawag-SIAM/SimulatedAnnealingABC.jl/blob/cda55d4c5ae1c5fa4d7c364cac478c6fbd87b824/src/SimulatedAnnealingABC.jl#L44-L52">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../example/">« Worked Example</a><a class="docs-footer-nextpage" href="../related/">Related packages »</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.6.0 on <span class="colophon-date" title="Sunday 25 August 2024 12:11">Sunday 25 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+                   kwargs...)</code></pre><p>Updates particles with <code>n_simulation</code> and applies importance sampling if needed. Modifies <code>population_state</code>.</p><p><strong>Arguments</strong></p><p>See docstring for <code>sabc</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Eawag-SIAM/SimulatedAnnealingABC.jl/blob/8ac7bf40665aa20cd7e76a9adbbd9b9d9155a5ee/src/SimulatedAnnealingABC.jl#L249-L268">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="SimulatedAnnealingABC.SABCresult" href="#SimulatedAnnealingABC.SABCresult"><code>SimulatedAnnealingABC.SABCresult</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><p>Holds results from a SABC run with fields:</p><ul><li><code>population</code>: vector of parameter samples from the approximate posterior</li><li><code>u</code>: transformed distances</li><li><code>ρ</code>: distances</li><li><code>state</code>: state of algorithm</li></ul><p>The history of ϵ can be accessed with the field <code>state.ϵ_history</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Eawag-SIAM/SimulatedAnnealingABC.jl/blob/8ac7bf40665aa20cd7e76a9adbbd9b9d9155a5ee/src/SimulatedAnnealingABC.jl#L44-L52">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../example/">« Worked Example</a><a class="docs-footer-nextpage" href="../related/">Related packages »</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.6.0 on <span class="colophon-date" title="Sunday 25 August 2024 12:15">Sunday 25 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>