Skip to content

Commit

Permalink
build based on 07dd3cd
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 26, 2024
1 parent 398001b commit 2812228
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion previews/PR39/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-25T18:03:19","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-26T19:39:44","documenter_version":"1.8.0"}}
30 changes: 15 additions & 15 deletions previews/PR39/api/cells/index.html
View file

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions previews/PR39/api/layers/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR39/api/wrappers/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Wrappers · RecurrentLayers.jl</title><meta name="title" content="Wrappers · RecurrentLayers.jl"/><meta property="og:title" content="Wrappers · RecurrentLayers.jl"/><meta property="twitter:title" content="Wrappers · RecurrentLayers.jl"/><meta name="description" content="Documentation for RecurrentLayers.jl."/><meta property="og:description" content="Documentation for RecurrentLayers.jl."/><meta property="twitter:description" content="Documentation for RecurrentLayers.jl."/><meta property="og:url" content="https://MartinuzziFrancesco.github.io/RecurrentLayers.jl/api/wrappers/"/><meta property="twitter:url" content="https://MartinuzziFrancesco.github.io/RecurrentLayers.jl/api/wrappers/"/><link rel="canonical" href="https://MartinuzziFrancesco.github.io/RecurrentLayers.jl/api/wrappers/"/><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><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="RecurrentLayers.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">RecurrentLayers.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="../../">Home</a></li><li><span class="tocitem">API Documentation</span><ul><li><a class="tocitem" href="../cells/">Cells</a></li><li><a class="tocitem" href="../layers/">Layers</a></li><li class="is-active"><a class="tocitem" href>Wrappers</a></li></ul></li><li><a class="tocitem" href="../../roadmap/">Roadmap</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><a class="is-disabled">API Documentation</a></li><li class="is-active"><a href>Wrappers</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Wrappers</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/MartinuzziFrancesco/RecurrentLayers.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/MartinuzziFrancesco/RecurrentLayers.jl/blob/main/docs/src/api/wrappers.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="Wrappers"><a class="docs-heading-anchor" href="#Wrappers">Wrappers</a><a id="Wrappers-1"></a><a class="docs-heading-anchor-permalink" href="#Wrappers" 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="RecurrentLayers.StackedRNN" href="#RecurrentLayers.StackedRNN"><code>RecurrentLayers.StackedRNN</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">StackedRNN(rlayer, (input_size, hidden_size), args...;
num_layers = 1, kwargs...)</code></pre><p>Constructs a stack of recurrent layers given the recurrent layer type.</p><p>Arguments:</p><ul><li><code>rlayer</code>: Any recurrent layer such as <a href="../layers/#RecurrentLayers.MGU">MGU</a>, <a href="../layers/#RecurrentLayers.RHN">RHN</a>, etc... or <a href="https://fluxml.ai/Flux.jl/stable/reference/models/layers/#Flux.RNN"><code>Flux.RNN</code></a>, <a href="https://fluxml.ai/Flux.jl/stable/reference/models/layers/#Flux.LSTM"><code>Flux.LSTM</code></a>, etc.</li><li><code>input_size</code>: Defines the input dimension for the first layer.</li><li><code>hidden_size</code>: defines the dimension of the hidden layer.</li><li><code>num_layers</code>: The number of layers to stack. Default is 1.</li><li><code>args...</code>: Additional positional arguments passed to the recurrent layer.</li><li><code>kwargs...</code>: Additional keyword arguments passed to the recurrent layers.</li></ul><p>Returns: A <code>StackedRNN</code> instance containing the specified number of RNN layers and their initial states.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MartinuzziFrancesco/RecurrentLayers.jl/blob/02404f926a590abb756f6894dcdbc05848b85d27/src/wrappers/stackedrnn.jl#L10-L27">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../layers/">« Layers</a><a class="docs-footer-nextpage" href="../../roadmap/">Roadmap »</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="Wednesday 25 December 2024 18:03">Wednesday 25 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
num_layers = 1, kwargs...)</code></pre><p>Constructs a stack of recurrent layers given the recurrent layer type.</p><p>Arguments:</p><ul><li><code>rlayer</code>: Any recurrent layer such as <a href="../layers/#RecurrentLayers.MGU">MGU</a>, <a href="../layers/#RecurrentLayers.RHN">RHN</a>, etc... or <a href="https://fluxml.ai/Flux.jl/stable/reference/models/layers/#Flux.RNN"><code>Flux.RNN</code></a>, <a href="https://fluxml.ai/Flux.jl/stable/reference/models/layers/#Flux.LSTM"><code>Flux.LSTM</code></a>, etc.</li><li><code>input_size</code>: Defines the input dimension for the first layer.</li><li><code>hidden_size</code>: defines the dimension of the hidden layer.</li><li><code>num_layers</code>: The number of layers to stack. Default is 1.</li><li><code>args...</code>: Additional positional arguments passed to the recurrent layer.</li><li><code>kwargs...</code>: Additional keyword arguments passed to the recurrent layers.</li></ul><p>Returns: A <code>StackedRNN</code> instance containing the specified number of RNN layers and their initial states.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/MartinuzziFrancesco/RecurrentLayers.jl/blob/07dd3cdcef5a917d27c77976729c6de1f4e9bc10/src/wrappers/stackedrnn.jl#L10-L27">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../layers/">« Layers</a><a class="docs-footer-nextpage" href="../../roadmap/">Roadmap »</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="Thursday 26 December 2024 19:39">Thursday 26 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 2812228

Please sign in to comment.