Skip to content

Commit 2947f8e

Browse files
author
Documenter.jl
committed
build based on fa2b217
1 parent 6af855c commit 2947f8e

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-05-26T13:58:56","julia_version":"1.12.6"}}
1+
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-05-30T10:49:43","julia_version":"1.12.6"}}

dev/api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
julia> s = ZeroSurrogate();
77

88
julia> s([4]) == 0
9-
true</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/352e6d48146d87ac5d03d96cc432e1e543937641/src/SurrogatesBase.jl#L10-L33">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.AbstractStochasticSurrogate"><a class="docstring-binding" href="#SurrogatesBase.AbstractStochasticSurrogate"><code>SurrogatesBase.AbstractStochasticSurrogate</code></a><span class="docstring-category">Type</span></summary><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/352e6d48146d87ac5d03d96cc432e1e543937641/src/SurrogatesBase.jl#L36-L42">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.finite_posterior"><a class="docstring-binding" href="#SurrogatesBase.finite_posterior"><code>SurrogatesBase.finite_posterior</code></a><span class="docstring-category">Function</span></summary><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/352e6d48146d87ac5d03d96cc432e1e543937641/src/SurrogatesBase.jl#L86-L101">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.hyperparameters"><a class="docstring-binding" href="#SurrogatesBase.hyperparameters"><code>SurrogatesBase.hyperparameters</code></a><span class="docstring-category">Function</span></summary><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/352e6d48146d87ac5d03d96cc432e1e543937641/src/SurrogatesBase.jl#L77-L83">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.parameters"><a class="docstring-binding" href="#SurrogatesBase.parameters"><code>SurrogatesBase.parameters</code></a><span class="docstring-category">Function</span></summary><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/352e6d48146d87ac5d03d96cc432e1e543937641/src/SurrogatesBase.jl#L59-L63">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.update!"><a class="docstring-binding" href="#SurrogatesBase.update!"><code>SurrogatesBase.update!</code></a><span class="docstring-category">Function</span></summary><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/352e6d48146d87ac5d03d96cc432e1e543937641/src/SurrogatesBase.jl#L45-L56">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.update_hyperparameters!"><a class="docstring-binding" href="#SurrogatesBase.update_hyperparameters!"><code>SurrogatesBase.update_hyperparameters!</code></a><span class="docstring-category">Function</span></summary><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/352e6d48146d87ac5d03d96cc432e1e543937641/src/SurrogatesBase.jl#L66-L74">source</a></section></details></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.17.0 on <span class="colophon-date" title="Tuesday 26 May 2026 13:58">Tuesday 26 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
9+
true</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/SurrogatesBase.jl/blob/fa2b217612f1a8174809537d055690f5868b40a2/src/SurrogatesBase.jl#L10-L33">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.AbstractStochasticSurrogate"><a class="docstring-binding" href="#SurrogatesBase.AbstractStochasticSurrogate"><code>SurrogatesBase.AbstractStochasticSurrogate</code></a><span class="docstring-category">Type</span></summary><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/fa2b217612f1a8174809537d055690f5868b40a2/src/SurrogatesBase.jl#L36-L42">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.finite_posterior"><a class="docstring-binding" href="#SurrogatesBase.finite_posterior"><code>SurrogatesBase.finite_posterior</code></a><span class="docstring-category">Function</span></summary><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/fa2b217612f1a8174809537d055690f5868b40a2/src/SurrogatesBase.jl#L86-L101">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.hyperparameters"><a class="docstring-binding" href="#SurrogatesBase.hyperparameters"><code>SurrogatesBase.hyperparameters</code></a><span class="docstring-category">Function</span></summary><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/fa2b217612f1a8174809537d055690f5868b40a2/src/SurrogatesBase.jl#L77-L83">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.parameters"><a class="docstring-binding" href="#SurrogatesBase.parameters"><code>SurrogatesBase.parameters</code></a><span class="docstring-category">Function</span></summary><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/fa2b217612f1a8174809537d055690f5868b40a2/src/SurrogatesBase.jl#L59-L63">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.update!"><a class="docstring-binding" href="#SurrogatesBase.update!"><code>SurrogatesBase.update!</code></a><span class="docstring-category">Function</span></summary><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/fa2b217612f1a8174809537d055690f5868b40a2/src/SurrogatesBase.jl#L45-L56">source</a></section></details></article><article><details class="docstring" open="true"><summary id="SurrogatesBase.update_hyperparameters!"><a class="docstring-binding" href="#SurrogatesBase.update_hyperparameters!"><code>SurrogatesBase.update_hyperparameters!</code></a><span class="docstring-category">Function</span></summary><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/fa2b217612f1a8174809537d055690f5868b40a2/src/SurrogatesBase.jl#L66-L74">source</a></section></details></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.17.0 on <span class="colophon-date" title="Saturday 30 May 2026 10:49">Saturday 30 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/assets/Manifest.toml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
Official https://julialang.org release
99
Platform Info:
1010
OS: Linux (x86_64-linux-gnu)
11-
CPU: 4 × AMD EPYC 7763 64-Core Processor
11+
CPU: 4 × AMD EPYC 9V74 80-Core Processor
1212
WORD_SIZE: 64
13-
LLVM: libLLVM-18.1.7 (ORCJIT, znver3)
13+
LLVM: libLLVM-18.1.7 (ORCJIT, znver4)
1414
GC: Built with stock GC
1515
Threads: 1 default, 1 interactive, 1 GC (on 4 virtual cores)</code></pre></details><details><summary>A more complete overview of all dependencies and their versions is also provided.</summary><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Status `~/work/SurrogatesBase.jl/SurrogatesBase.jl/docs/Manifest.toml`
1616
[a4c015fc] ANSIColoredPrinters v0.0.1
@@ -31,7 +31,7 @@
3131
[ec057cc2] StructUtils v2.8.2
3232
[89f642e6] SurrogatesBase v1.1.0 `~/work/SurrogatesBase.jl/SurrogatesBase.jl`
3333
[3bb67fe8] TranscodingStreams v0.11.3
34-
[2e619515] Expat_jll v2.8.0+0
34+
[2e619515] Expat_jll v2.8.1+0
3535
[020c3dae] Git_LFS_jll v3.7.1+0
3636
[f8c6e375] Git_jll v2.54.0+0
3737
[94ce4f54] Libiconv_jll v1.18.0+0
@@ -72,4 +72,4 @@
7272
[efcefdf7] PCRE2_jll v10.44.0+1
7373
[83775a58] Zlib_jll v1.3.1+2
7474
[8e850ede] nghttp2_jll v1.64.0+1
75-
[3f19e933] p7zip_jll v17.7.0+0</code></pre></details><p>You can also download the <a href="https://github.com/SciML/SurrogatesBase.jl/tree/gh-pages/v1.1.0/assets/Manifest.toml">manifest</a> file and the <a href="https://github.com/SciML/SurrogatesBase.jl/tree/gh-pages/v1.1.0/assets/Project.toml">project</a> file.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" 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.17.0 on <span class="colophon-date" title="Tuesday 26 May 2026 13:58">Tuesday 26 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
75+
[3f19e933] p7zip_jll v17.7.0+0</code></pre></details><p>You can also download the <a href="https://github.com/SciML/SurrogatesBase.jl/tree/gh-pages/v1.1.0/assets/Manifest.toml">manifest</a> file and the <a href="https://github.com/SciML/SurrogatesBase.jl/tree/gh-pages/v1.1.0/assets/Project.toml">project</a> file.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" 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.17.0 on <span class="colophon-date" title="Saturday 30 May 2026 10:49">Saturday 30 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)