Deployed 91d56f7 with MkDocs version: 1.6.1

Author: thib-s

api/activations/index.html

@@ -894,7 +894,8 @@ <h2 id="orthogonium.layers.custom_activations.HouseHolder" class="doc doc-headin
 
               <details class="quote">
                 <summary>Source code in <code>orthogonium\layers\custom_activations.py</code></summary>
-                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">48</span>
+                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">47</span>
+<span class="normal">48</span>
 <span class="normal">49</span>
 <span class="normal">50</span>
 <span class="normal">51</span>
@@ -931,8 +932,7 @@ <h2 id="orthogonium.layers.custom_activations.HouseHolder" class="doc doc-headin
 <span class="normal">82</span>
 <span class="normal">83</span>
 <span class="normal">84</span>
-<span class="normal">85</span>
-<span class="normal">86</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">HouseHolder</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+<span class="normal">85</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">HouseHolder</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channels</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        A activation that applies a parameterized transformation via Householder</span>
@@ -1089,7 +1089,8 @@ <h3 id="orthogonium.layers.custom_activations.HouseHolder.__init__" class="doc d
 
             <details class="quote">
               <summary>Source code in <code>orthogonium\layers\custom_activations.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">49</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">48</span>
+<span class="normal">49</span>
 <span class="normal">50</span>
 <span class="normal">51</span>
 <span class="normal">52</span>
@@ -1112,8 +1113,7 @@ <h3 id="orthogonium.layers.custom_activations.HouseHolder.__init__" class="doc d
 <span class="normal">69</span>
 <span class="normal">70</span>
 <span class="normal">71</span>
-<span class="normal">72</span>
-<span class="normal">73</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channels</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+<span class="normal">72</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channels</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    A activation that applies a parameterized transformation via Householder</span>
 <span class="sd">    reflection technique. It is initialized with the number of input channels, which must</span>
@@ -1175,7 +1175,8 @@ <h2 id="orthogonium.layers.custom_activations.HouseHolder_Order_2" class="doc do
 
               <details class="quote">
                 <summary>Source code in <code>orthogonium\layers\custom_activations.py</code></summary>
-                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 89</span>
+                <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 88</span>
+<span class="normal"> 89</span>
 <span class="normal"> 90</span>
 <span class="normal"> 91</span>
 <span class="normal"> 92</span>
@@ -1260,8 +1261,7 @@ <h2 id="orthogonium.layers.custom_activations.HouseHolder_Order_2" class="doc do
 <span class="normal">171</span>
 <span class="normal">172</span>
 <span class="normal">173</span>
-<span class="normal">174</span>
-<span class="normal">175</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">HouseHolder_Order_2</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+<span class="normal">174</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">HouseHolder_Order_2</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channels</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Represents a layer or module that performs operations using Householder</span>
@@ -1498,7 +1498,8 @@ <h3 id="orthogonium.layers.custom_activations.HouseHolder_Order_2.__init__" clas
 
             <details class="quote">
               <summary>Source code in <code>orthogonium\layers\custom_activations.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 90</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 89</span>
+<span class="normal"> 90</span>
 <span class="normal"> 91</span>
 <span class="normal"> 92</span>
 <span class="normal"> 93</span>
@@ -1543,8 +1544,7 @@ <h3 id="orthogonium.layers.custom_activations.HouseHolder_Order_2.__init__" clas
 <span class="normal">132</span>
 <span class="normal">133</span>
 <span class="normal">134</span>
-<span class="normal">135</span>
-<span class="normal">136</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channels</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+<span class="normal">135</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channels</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Represents a layer or module that performs operations using Householder</span>
 <span class="sd">    transformations of order 2, parameterized by angles corresponding to</span>
@@ -1645,17 +1645,15 @@ <h2 id="orthogonium.layers.custom_activations.MaxMin" class="doc doc-heading">
 <span class="normal">41</span>
 <span class="normal">42</span>
 <span class="normal">43</span>
-<span class="normal">44</span>
-<span class="normal">45</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">MaxMin</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+<span class="normal">44</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">MaxMin</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        This class implements the MaxMin activation function. Which is a</span>
 <span class="sd">        pairwise activation function that returns the maximum and minimum (ordered)</span>
 <span class="sd">        of each pair of elements in the input tensor.</span>
 
 <span class="sd">        Parameters</span>
-<span class="sd">        ----------</span>
-<span class="sd">        axis : int, default=1 the axis along which to apply the activation function.</span>
+<span class="sd">            axis : int, default=1 the axis along which to apply the activation function.</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">axis</span> <span class="o">=</span> <span class="n">axis</span>
@@ -1694,8 +1692,8 @@ <h3 id="orthogonium.layers.custom_activations.MaxMin.__init__" class="doc doc-he
         <p>This class implements the MaxMin activation function. Which is a
 pairwise activation function that returns the maximum and minimum (ordered)
 of each pair of elements in the input tensor.</p>
-<h5 id="orthogonium.layers.custom_activations.MaxMin.__init__--parameters">Parameters<a class="headerlink" href="#orthogonium.layers.custom_activations.MaxMin.__init__--parameters" title="Permanent link">&para;</a></h5>
-<p>axis : int, default=1 the axis along which to apply the activation function.</p>
+<p>Parameters
+    axis : int, default=1 the axis along which to apply the activation function.</p>
 
             <details class="quote">
               <summary>Source code in <code>orthogonium\layers\custom_activations.py</code></summary>
@@ -1710,16 +1708,14 @@ <h5 id="orthogonium.layers.custom_activations.MaxMin.__init__--parameters">Param
 <span class="normal">36</span>
 <span class="normal">37</span>
 <span class="normal">38</span>
-<span class="normal">39</span>
-<span class="normal">40</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
+<span class="normal">39</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    This class implements the MaxMin activation function. Which is a</span>
 <span class="sd">    pairwise activation function that returns the maximum and minimum (ordered)</span>
 <span class="sd">    of each pair of elements in the input tensor.</span>
 
 <span class="sd">    Parameters</span>
-<span class="sd">    ----------</span>
-<span class="sd">    axis : int, default=1 the axis along which to apply the activation function.</span>
+<span class="sd">        axis : int, default=1 the axis along which to apply the activation function.</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">axis</span> <span class="o">=</span> <span class="n">axis</span>