Deploying to gh-pages from @ d9aeca9 🚀

ml4gw.html

@@ -159,7 +159,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.augmentations.SignalInverter.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.augmentations.SignalInverter.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -187,7 +187,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.augmentations.SignalReverser.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.augmentations.SignalReverser.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>

ml4gw.nn.autoencoder.html

@@ -136,7 +136,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.autoencoder.base.Autoencoder.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">X</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.autoencoder.base.Autoencoder.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -189,7 +189,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.autoencoder.convolutional.ConvolutionalAutoencoder.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.autoencoder.convolutional.ConvolutionalAutoencoder.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -207,12 +207,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <span id="ml4gw-nn-autoencoder-skip-connection-module"></span><h2>ml4gw.nn.autoencoder.skip_connection module<a class="headerlink" href="#module-ml4gw.nn.autoencoder.skip_connection" title="Permalink to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="ml4gw.nn.autoencoder.skip_connection.AddSkipConnect">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ml4gw.nn.autoencoder.skip_connection.</span></span><span class="sig-name descname"><span class="pre">AddSkipConnect</span></span><a class="headerlink" href="#ml4gw.nn.autoencoder.skip_connection.AddSkipConnect" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ml4gw.nn.autoencoder.skip_connection.</span></span><span class="sig-name descname"><span class="pre">AddSkipConnect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.autoencoder.skip_connection.AddSkipConnect" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#ml4gw.nn.autoencoder.skip_connection.SkipConnection" title="ml4gw.nn.autoencoder.skip_connection.SkipConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">SkipConnection</span></code></a></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.autoencoder.skip_connection.AddSkipConnect.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.autoencoder.skip_connection.AddSkipConnect.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -232,7 +232,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.autoencoder.skip_connection.ConcatSkipConnect.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.autoencoder.skip_connection.ConcatSkipConnect.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -252,12 +252,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="py class">
 <dt class="sig sig-object py" id="ml4gw.nn.autoencoder.skip_connection.SkipConnection">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ml4gw.nn.autoencoder.skip_connection.</span></span><span class="sig-name descname"><span class="pre">SkipConnection</span></span><a class="headerlink" href="#ml4gw.nn.autoencoder.skip_connection.SkipConnection" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ml4gw.nn.autoencoder.skip_connection.</span></span><span class="sig-name descname"><span class="pre">SkipConnection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.autoencoder.skip_connection.SkipConnection" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.autoencoder.skip_connection.SkipConnection.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">X</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.autoencoder.skip_connection.SkipConnection.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>

ml4gw.nn.html

@@ -240,7 +240,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.norm.GroupNorm1D.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.norm.GroupNorm1D.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>

ml4gw.nn.resnet.html

@@ -122,7 +122,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.resnet.resnet_1d.BasicBlock.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.resnet.resnet_1d.BasicBlock.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.
 :rtype: <span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></span></p>
 <div class="admonition note">
@@ -154,7 +154,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.resnet.resnet_1d.Bottleneck.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.resnet.resnet_1d.Bottleneck.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.
 :rtype: <span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></span></p>
 <div class="admonition note">
@@ -235,7 +235,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.resnet.resnet_1d.ResNet1D.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.resnet.resnet_1d.ResNet1D.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.
 :rtype: <span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></span></p>
 <div class="admonition note">
@@ -290,7 +290,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.resnet.resnet_2d.BasicBlock.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.resnet.resnet_2d.BasicBlock.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.
 :rtype: <span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></span></p>
 <div class="admonition note">
@@ -322,7 +322,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.resnet.resnet_2d.Bottleneck.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.resnet.resnet_2d.Bottleneck.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.
 :rtype: <span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></span></p>
 <div class="admonition note">
@@ -406,7 +406,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.resnet.resnet_2d.ResNet2D.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.resnet.resnet_2d.ResNet2D.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.
 :rtype: <span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></span></p>
 <div class="admonition note">

ml4gw.nn.streaming.html

@@ -130,7 +130,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.streaming.online_average.OnlineAverager.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.streaming.online_average.OnlineAverager.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.
 :rtype: <span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code>]</span></p>
 <div class="admonition note">
@@ -198,7 +198,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="py method">
 <dt class="sig sig-object py" id="ml4gw.nn.streaming.snapshotter.Snapshotter.forward">
 <span class="sig-name descname"><span class="pre">forward</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">snapshot</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ml4gw.nn.streaming.snapshotter.Snapshotter.forward" title="Permalink to this definition"></a></dt>
-<dd><p>Defines the computation performed at every call.</p>
+<dd><p>Define the computation performed at every call.</p>
 <p>Should be overridden by all subclasses.
 :rtype: <span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code>]</span></p>
 <div class="admonition note">