Skip to content

Commit 895a7c9

Browse files
author
Documenter.jl
committed
build based on f5c3352
1 parent b5edc25 commit 895a7c9

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-01-19T08:48:33","documenter_version":"1.8.0"}}
1+
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-01-31T23:04:12","documenter_version":"1.8.0"}}

dev/api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<!DOCTYPE html>
22
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · Capse.jl</title><meta name="title" content="API · Capse.jl"/><meta property="og:title" content="API · Capse.jl"/><meta property="twitter:title" content="API · Capse.jl"/><meta name="description" content="Documentation for Capse.jl."/><meta property="og:description" content="Documentation for Capse.jl."/><meta property="twitter:description" content="Documentation for Capse.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img class="docs-light-only" src="../assets/logo.svg" alt="Capse.jl logo"/><img class="docs-dark-only" src="../assets/logo-dark.svg" alt="Capse.jl logo"/></a><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></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/CosmologicalEmulators/Capse.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/CosmologicalEmulators/Capse.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-reference"><a class="docs-heading-anchor" href="#API-reference">API reference</a><a id="API-reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-reference" 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="Capse.CℓEmulator" href="#Capse.CℓEmulator"><code>Capse.CℓEmulator</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">CℓEmulator(TrainedEmulator::AbstractTrainedEmulators, ℓgrid::Array,
3-
InMinMax::Matrix, OutMinMax::Matrix)</code></pre><p>This is the fundamental struct used to obtain the <span>$C_\ell$</span>&#39;s from an emulator. It contains:</p><ul><li><p><code>TrainedEmulator::AbstractTrainedEmulators</code>, the trained emulator</p></li><li><p><code>ℓgrid::AbstractVector</code>, the <span>$\ell$</span>-grid the emulator has been trained on.</p></li><li><p><code>InMinMax::AbstractMatrix</code>, the <code>Matrix</code> used for the MinMax normalization of the input features</p></li><li><p><code>OutMinMax::AbstractMatrix</code>, the <code>Matrix</code> used for the MinMax normalization of the output features</p></li><li><p><code>Postprocessing::Function</code>, the <code>Function</code> used for the postprocessing of the NN output</p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/6948f27d716a0686237e702252febfeeed105a5c/src/Capse.jl#L14-L30">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="Capse.get_Cℓ" href="#Capse.get_Cℓ"><code>Capse.get_Cℓ</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">get_Cℓ(input_params, Cℓemu::AbstractCℓEmulators)</code></pre><p>Computes and returns the <span>$C_\ell$</span>&#39;s on the <span>$\ell$</span>-grid the emulator has been trained on given input array <code>input_params</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/6948f27d716a0686237e702252febfeeed105a5c/src/Capse.jl#L41-L45">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="Capse.get_ℓgrid" href="#Capse.get_ℓgrid"><code>Capse.get_ℓgrid</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">get_ℓgrid(CℓEmulator::AbstractCℓEmulators)</code></pre><p>Returns the <span>$\ell$</span>-grid the emulator has been trained on.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/6948f27d716a0686237e702252febfeeed105a5c/src/Capse.jl#L53-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="AbstractCosmologicalEmulators.get_emulator_description" href="#AbstractCosmologicalEmulators.get_emulator_description"><code>AbstractCosmologicalEmulators.get_emulator_description</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">get_emulator_description(Cℓemu::AbstractCℓEmulators)</code></pre><p>Print on screen the emulator description.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/6948f27d716a0686237e702252febfeeed105a5c/src/Capse.jl#L61-L64">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="Capse.load_emulator" href="#Capse.load_emulator"><code>Capse.load_emulator</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">load_emulator(path::String, emu_backend::AbstractTrainedEmulators)</code></pre><p>Load the emulator with the files in the folder <code>path</code>, using the backend defined by <code>emu_backend</code>. The following keyword arguments are used to specify the name of the files used to load the emulator:</p><ul><li><code>ℓ_file</code>, default <code>l.npy</code></li><li><code>weights_file</code>, default <code>weights.npy</code></li><li><code>inminmax_file</code>, default <code>inminmax.npy</code></li><li><code>outminmax_file</code>, default <code>outminmax.npy</code></li><li><code>nn_setup_file</code>, default <code>nn_setup.json</code></li><li><code>postprocessing_file</code>, default <code>postprocessing.jl</code></li></ul><p>If the corresponding file in the folder you are trying to load have different names, change the default values accordingly.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/6948f27d716a0686237e702252febfeeed105a5c/src/Capse.jl#L69-L81">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="Sunday 19 January 2025 08:48">Sunday 19 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
3+
InMinMax::Matrix, OutMinMax::Matrix)</code></pre><p>This is the fundamental struct used to obtain the <span>$C_\ell$</span>&#39;s from an emulator. It contains:</p><ul><li><p><code>TrainedEmulator::AbstractTrainedEmulators</code>, the trained emulator</p></li><li><p><code>ℓgrid::AbstractVector</code>, the <span>$\ell$</span>-grid the emulator has been trained on.</p></li><li><p><code>InMinMax::AbstractMatrix</code>, the <code>Matrix</code> used for the MinMax normalization of the input features</p></li><li><p><code>OutMinMax::AbstractMatrix</code>, the <code>Matrix</code> used for the MinMax normalization of the output features</p></li><li><p><code>Postprocessing::Function</code>, the <code>Function</code> used for the postprocessing of the NN output</p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/f5c3352f4706231262cd91d69e6f27103109121b/src/Capse.jl#L14-L30">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="Capse.get_Cℓ" href="#Capse.get_Cℓ"><code>Capse.get_Cℓ</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">get_Cℓ(input_params, Cℓemu::AbstractCℓEmulators)</code></pre><p>Computes and returns the <span>$C_\ell$</span>&#39;s on the <span>$\ell$</span>-grid the emulator has been trained on given input array <code>input_params</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/f5c3352f4706231262cd91d69e6f27103109121b/src/Capse.jl#L41-L45">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="Capse.get_ℓgrid" href="#Capse.get_ℓgrid"><code>Capse.get_ℓgrid</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">get_ℓgrid(CℓEmulator::AbstractCℓEmulators)</code></pre><p>Returns the <span>$\ell$</span>-grid the emulator has been trained on.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/f5c3352f4706231262cd91d69e6f27103109121b/src/Capse.jl#L53-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="AbstractCosmologicalEmulators.get_emulator_description" href="#AbstractCosmologicalEmulators.get_emulator_description"><code>AbstractCosmologicalEmulators.get_emulator_description</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">get_emulator_description(Cℓemu::AbstractCℓEmulators)</code></pre><p>Print on screen the emulator description.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/f5c3352f4706231262cd91d69e6f27103109121b/src/Capse.jl#L61-L64">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="Capse.load_emulator" href="#Capse.load_emulator"><code>Capse.load_emulator</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">load_emulator(path::String, emu_backend::AbstractTrainedEmulators)</code></pre><p>Load the emulator with the files in the folder <code>path</code>, using the backend defined by <code>emu_backend</code>. The following keyword arguments are used to specify the name of the files used to load the emulator:</p><ul><li><code>ℓ_file</code>, default <code>l.npy</code></li><li><code>weights_file</code>, default <code>weights.npy</code></li><li><code>inminmax_file</code>, default <code>inminmax.npy</code></li><li><code>outminmax_file</code>, default <code>outminmax.npy</code></li><li><code>nn_setup_file</code>, default <code>nn_setup.json</code></li><li><code>postprocessing_file</code>, default <code>postprocessing.jl</code></li></ul><p>If the corresponding file in the folder you are trying to load have different names, change the default values accordingly.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CosmologicalEmulators/Capse.jl/blob/f5c3352f4706231262cd91d69e6f27103109121b/src/Capse.jl#L69-L81">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="Friday 31 January 2025 23:04">Friday 31 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)