build based on bc3d989

SciML · Oct 3, 2023 · 8d8aefe · 8d8aefe
1 parent 27c3f7e
commit 8d8aefe
Show file tree

Hide file tree

Showing 37 changed files with 14,665 additions and 0 deletions.
diff --git a/previews/PR178/.documenter-siteinfo.json b/previews/PR178/.documenter-siteinfo.json
@@ -0,0 +1 @@
+{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-03T00:30:30","documenter_version":"1.1.0"}}
diff --git a/previews/PR178/api/esn/index.html b/previews/PR178/api/esn/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Echo State Networks · ReservoirComputing.jl</title><meta name="title" content="Echo State Networks · ReservoirComputing.jl"/><meta property="og:title" content="Echo State Networks · ReservoirComputing.jl"/><meta property="twitter:title" content="Echo State Networks · ReservoirComputing.jl"/><meta name="description" content="Documentation for ReservoirComputing.jl."/><meta property="og:description" content="Documentation for ReservoirComputing.jl."/><meta property="twitter:description" content="Documentation for ReservoirComputing.jl."/><meta property="og:url" content="https://docs.sciml.ai/ReservoirComputing/stable/api/esn/"/><meta property="twitter:url" content="https://docs.sciml.ai/ReservoirComputing/stable/api/esn/"/><link rel="canonical" href="https://docs.sciml.ai/ReservoirComputing/stable/api/esn/"/><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/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><link href="../../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="ReservoirComputing.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">ReservoirComputing.jl</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="../../">ReservoirComputing.jl</a></li><li><span class="tocitem">General Settings</span><ul><li><a class="tocitem" href="../../general/different_training/">Changing Training Algorithms</a></li><li><a class="tocitem" href="../../general/states_variation/">Altering States</a></li><li><a class="tocitem" href="../../general/predictive_generative/">Generative vs Predictive</a></li></ul></li><li><span class="tocitem">Echo State Network Tutorials</span><ul><li><a class="tocitem" href="../../esn_tutorials/lorenz_basic/">Lorenz System Forecasting</a></li><li><a class="tocitem" href="../../esn_tutorials/change_layers/">Using Different Layers</a></li><li><a class="tocitem" href="../../esn_tutorials/different_drivers/">Using Different Reservoir Drivers</a></li><li><a class="tocitem" href="../../esn_tutorials/deep_esn/">Deep Echo State Networks</a></li><li><a class="tocitem" href="../../esn_tutorials/hybrid/">Hybrid Echo State Networks</a></li></ul></li><li><a class="tocitem" href="../../reca_tutorials/reca/">Reservoir Computing with Cellular Automata</a></li><li><span class="tocitem">API Documentation</span><ul><li><a class="tocitem" href="../training/">Training Algorithms</a></li><li><a class="tocitem" href="../states/">States Modifications</a></li><li><a class="tocitem" href="../predict/">Prediction Types</a></li><li class="is-active"><a class="tocitem" href>Echo State Networks</a></li><li><a class="tocitem" href="../esn_layers/">ESN Layers</a></li><li><a class="tocitem" href="../esn_drivers/">ESN Drivers</a></li><li><a class="tocitem" href="../reca/">ReCA</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">API Documentation</a></li><li class="is-active"><a href>Echo State Networks</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Echo State Networks</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/SciML/ReservoirComputing.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/SciML/ReservoirComputing.jl/blob/master/docs/src/api/esn.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="Echo-State-Networks"><a class="docs-heading-anchor" href="#Echo-State-Networks">Echo State Networks</a><a id="Echo-State-Networks-1"></a><a class="docs-heading-anchor-permalink" href="#Echo-State-Networks" 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="ReservoirComputing.ESN" href="#ReservoirComputing.ESN"><code>ReservoirComputing.ESN</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">ESN(train_data;
+    variation = Default(),
+    input_layer = DenseLayer(),
+    reservoir = RandSparseReservoir(),
+    bias = NullLayer(),
+    reservoir_driver = RNN(),
+    nla_type = NLADefault(),
+    states_type = StandardStates())
+(esn::ESN)(prediction::AbstractPrediction,
+    output_layer::AbstractOutputLayer;
+    initial_conditions=output_layer.last_value,
+    last_state=esn.states[:, end])</code></pre><p>Constructor for the Echo State Network model. It requires the reservoir size as the input and the data for the training. It returns a struct ready to be trained with the states already harvested.</p><p>After the training, this struct can be used for the prediction following the second function call. This will take as input a prediction type and the output layer from the training. The <code>initial_conditions</code> and <code>last_state</code> parameters can be left as they are, unless there is a specific reason to change them. All the components are detailed in the API documentation. More examples are given in the general documentation.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/ReservoirComputing.jl/blob/bc3d9897a434d4f7ce5d89af0f31ce66f48344eb/src/esn/echostatenetwork.jl#L49-L72">source</a></section></article><p>In addition to all the components that can be explored in the documentation, a couple components need a separate introduction. The <code>variation</code> arguments can be</p><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="ReservoirComputing.Default" href="#ReservoirComputing.Default"><code>ReservoirComputing.Default</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Default()</code></pre><p>Sets the type of the ESN as the standard model. No parameters are needed.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/ReservoirComputing.jl/blob/bc3d9897a434d4f7ce5d89af0f31ce66f48344eb/src/esn/echostatenetwork.jl#L16-L20">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="ReservoirComputing.Hybrid" href="#ReservoirComputing.Hybrid"><code>ReservoirComputing.Hybrid</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Hybrid(prior_model, u0, tspan, datasize)</code></pre><p>Given the model parameters, returns an <code>Hybrid</code> variation of the ESN. This entails a different training and prediction. Construction based on [1].</p><p>[1] Jaideep Pathak et al. &quot;Hybrid Forecasting of Chaotic Processes: Using Machine Learning in Conjunction with a Knowledge-Based Model&quot; (2018)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/ReservoirComputing.jl/blob/bc3d9897a434d4f7ce5d89af0f31ce66f48344eb/src/esn/echostatenetwork.jl#L31-L39">source</a></section></article><p>These arguments detail a deeper variation of the underlying model, and they need a separate call. For the moment, the most complex is the <code>Hybrid</code> call, but this can and will change in the future. All ESN models can be trained using the following call:</p><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="ReservoirComputing.train" href="#ReservoirComputing.train"><code>ReservoirComputing.train</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">train(esn::AbstractEchoStateNetwork, target_data, training_method=StandardRidge(0.0))</code></pre><p>Training of the built ESN over the <code>target_data</code>. The default training method is RidgeRegression. The output is an <code>OutputLayer</code> object to be fed to the esn call for the prediction.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/ReservoirComputing.jl/blob/bc3d9897a434d4f7ce5d89af0f31ce66f48344eb/src/esn/echostatenetwork.jl#L189-L195">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../predict/">« Prediction Types</a><a class="docs-footer-nextpage" href="../esn_layers/">ESN Layers »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Tuesday 3 October 2023 00:30">Tuesday 3 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>