Skip to content

Commit

Permalink
build based on f87e6e7
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 17, 2024
1 parent 3b48f0b commit d6ca895
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.0","generation_timestamp":"2024-10-15T13:07:11","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-17T17:27:21","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
julia> s = ZeroSurrogate();

julia> s([4]) == 0
true</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/ccf6144d288a6dc5c7d907865e849c210b57a6e2/src/SurrogatesBase.jl#L10-L33">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="SurrogatesBase.AbstractStochasticSurrogate" href="#SurrogatesBase.AbstractStochasticSurrogate"><code>SurrogatesBase.AbstractStochasticSurrogate</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">abstract type AbstractStochasticSurrogate end</code></pre><p>An abstract type for stochastic surrogates.</p><p>See also <a href="#SurrogatesBase.finite_posterior"><code>finite_posterior</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/ccf6144d288a6dc5c7d907865e849c210b57a6e2/src/SurrogatesBase.jl#L36-L42">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="SurrogatesBase.finite_posterior" href="#SurrogatesBase.finite_posterior"><code>SurrogatesBase.finite_posterior</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">finite_posterior(s::AbstractStochasticSurrogate, xs::AbstractVector)</code></pre><p>Return a posterior distribution at points <code>xs</code>.</p><p>An <code>AbstractStochasticSurrogate</code> might implement some or all of the following methods on the returned object:</p><ul><li><code>mean(finite_posterior(s,xs))</code> returns a <code>Vector</code> of posterior means at <code>xs</code></li><li><code>var(finite_posterior(s,xs))</code> returns a <code>Vector</code> of posterior variances at <code>xs</code></li><li><code>mean_and_var(finite_posterior(s,xs))</code> returns a <code>Tuple</code> consisting of a <code>Vector</code> of posterior means and a <code>Vector</code> of posterior variances at <code>xs</code></li><li><code>rand(finite_posterior(s,xs))</code> returns a <code>Vector</code>, which is a sample from the joint</li></ul><p>posterior at points <code>xs</code></p><p>Use <code>mean(finite_posterior(s, eachslice(X, dims = 2)))</code> if <code>X</code> is a matrix.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/ccf6144d288a6dc5c7d907865e849c210b57a6e2/src/SurrogatesBase.jl#L86-L101">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="SurrogatesBase.hyperparameters" href="#SurrogatesBase.hyperparameters"><code>SurrogatesBase.hyperparameters</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">hyperparameters(s)</code></pre><p>Returns current values of hyperparameters.</p><p>See also <a href="#SurrogatesBase.update_hyperparameters!"><code>update_hyperparameters!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/ccf6144d288a6dc5c7d907865e849c210b57a6e2/src/SurrogatesBase.jl#L77-L83">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="SurrogatesBase.parameters" href="#SurrogatesBase.parameters"><code>SurrogatesBase.parameters</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">parameters(s)</code></pre><p>Returns current values of parameters used in surrogate <code>s</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/ccf6144d288a6dc5c7d907865e849c210b57a6e2/src/SurrogatesBase.jl#L59-L63">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="SurrogatesBase.update!" href="#SurrogatesBase.update!"><code>SurrogatesBase.update!</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!(s, new_xs::AbstractVector, new_ys::AbstractVector)</code></pre><p>Include data <code>new_ys</code> at points <code>new_xs</code> into the surrogate <code>s</code>, i.e., refit the surrogate <code>s</code> to incorporate new data points.</p><p>If the surrogate <code>s</code> is a deterministic surrogate, the <code>new_ys</code> correspond to function evaluations, if <code>s</code> is a stochastic surrogate, the <code>new_ys</code> are samples from a conditional probability distribution.</p><p>Use <code>update!(s, eachslice(X, dims = 2), new_ys)</code> if <code>X</code> is a matrix.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/ccf6144d288a6dc5c7d907865e849c210b57a6e2/src/SurrogatesBase.jl#L45-L56">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="SurrogatesBase.update_hyperparameters!" href="#SurrogatesBase.update_hyperparameters!"><code>SurrogatesBase.update_hyperparameters!</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_hyperparameters!(s, prior)</code></pre><p>Update the hyperparameters of the surrogate <code>s</code> by performing hyperparameter optimization using the information in <code>prior</code>. After changing hyperparameters of <code>s</code>, fit <code>s</code> to past data.</p><p>See also <a href="#SurrogatesBase.hyperparameters"><code>hyperparameters</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/ccf6144d288a6dc5c7d907865e849c210b57a6e2/src/SurrogatesBase.jl#L66-L74">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../interface/">« The SurrogateBase Interface</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.7.0 on <span class="colophon-date" title="Tuesday 15 October 2024 13:07">Tuesday 15 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
true</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/f87e6e7a97af068073583f0b1296309b629a9803/src/SurrogatesBase.jl#L10-L33">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="SurrogatesBase.AbstractStochasticSurrogate" href="#SurrogatesBase.AbstractStochasticSurrogate"><code>SurrogatesBase.AbstractStochasticSurrogate</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">abstract type AbstractStochasticSurrogate end</code></pre><p>An abstract type for stochastic surrogates.</p><p>See also <a href="#SurrogatesBase.finite_posterior"><code>finite_posterior</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/f87e6e7a97af068073583f0b1296309b629a9803/src/SurrogatesBase.jl#L36-L42">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="SurrogatesBase.finite_posterior" href="#SurrogatesBase.finite_posterior"><code>SurrogatesBase.finite_posterior</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">finite_posterior(s::AbstractStochasticSurrogate, xs::AbstractVector)</code></pre><p>Return a posterior distribution at points <code>xs</code>.</p><p>An <code>AbstractStochasticSurrogate</code> might implement some or all of the following methods on the returned object:</p><ul><li><code>mean(finite_posterior(s,xs))</code> returns a <code>Vector</code> of posterior means at <code>xs</code></li><li><code>var(finite_posterior(s,xs))</code> returns a <code>Vector</code> of posterior variances at <code>xs</code></li><li><code>mean_and_var(finite_posterior(s,xs))</code> returns a <code>Tuple</code> consisting of a <code>Vector</code> of posterior means and a <code>Vector</code> of posterior variances at <code>xs</code></li><li><code>rand(finite_posterior(s,xs))</code> returns a <code>Vector</code>, which is a sample from the joint</li></ul><p>posterior at points <code>xs</code></p><p>Use <code>mean(finite_posterior(s, eachslice(X, dims = 2)))</code> if <code>X</code> is a matrix.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/f87e6e7a97af068073583f0b1296309b629a9803/src/SurrogatesBase.jl#L86-L101">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="SurrogatesBase.hyperparameters" href="#SurrogatesBase.hyperparameters"><code>SurrogatesBase.hyperparameters</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">hyperparameters(s)</code></pre><p>Returns current values of hyperparameters.</p><p>See also <a href="#SurrogatesBase.update_hyperparameters!"><code>update_hyperparameters!</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/f87e6e7a97af068073583f0b1296309b629a9803/src/SurrogatesBase.jl#L77-L83">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="SurrogatesBase.parameters" href="#SurrogatesBase.parameters"><code>SurrogatesBase.parameters</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">parameters(s)</code></pre><p>Returns current values of parameters used in surrogate <code>s</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/f87e6e7a97af068073583f0b1296309b629a9803/src/SurrogatesBase.jl#L59-L63">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="SurrogatesBase.update!" href="#SurrogatesBase.update!"><code>SurrogatesBase.update!</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!(s, new_xs::AbstractVector, new_ys::AbstractVector)</code></pre><p>Include data <code>new_ys</code> at points <code>new_xs</code> into the surrogate <code>s</code>, i.e., refit the surrogate <code>s</code> to incorporate new data points.</p><p>If the surrogate <code>s</code> is a deterministic surrogate, the <code>new_ys</code> correspond to function evaluations, if <code>s</code> is a stochastic surrogate, the <code>new_ys</code> are samples from a conditional probability distribution.</p><p>Use <code>update!(s, eachslice(X, dims = 2), new_ys)</code> if <code>X</code> is a matrix.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/f87e6e7a97af068073583f0b1296309b629a9803/src/SurrogatesBase.jl#L45-L56">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="SurrogatesBase.update_hyperparameters!" href="#SurrogatesBase.update_hyperparameters!"><code>SurrogatesBase.update_hyperparameters!</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_hyperparameters!(s, prior)</code></pre><p>Update the hyperparameters of the surrogate <code>s</code> by performing hyperparameter optimization using the information in <code>prior</code>. After changing hyperparameters of <code>s</code>, fit <code>s</code> to past data.</p><p>See also <a href="#SurrogatesBase.hyperparameters"><code>hyperparameters</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/f87e6e7a97af068073583f0b1296309b629a9803/src/SurrogatesBase.jl#L66-L74">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../interface/">« The SurrogateBase Interface</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.7.0 on <span class="colophon-date" title="Thursday 17 October 2024 17:27">Thursday 17 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
6 changes: 3 additions & 3 deletions dev/assets/Manifest.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is machine-generated - editing it directly is not advised

julia_version = "1.11.0"
julia_version = "1.11.1"
manifest_format = "2.0"
project_hash = "de226a46ac96f2c6398e379aa8421cb01c51318d"

Expand Down Expand Up @@ -89,9 +89,9 @@ version = "1.11.0"

[[deps.JLLWrappers]]
deps = ["Artifacts", "Preferences"]
git-tree-sha1 = "f389674c99bfcde17dc57454011aa44d5a260a40"
git-tree-sha1 = "be3dc50a92e5a386872a493a10050136d4703f9b"
uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
version = "1.6.0"
version = "1.6.1"

[[deps.JSON]]
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
Expand Down
Loading

0 comments on commit d6ca895

Please sign in to comment.