Merge pull request #33 from f-dangel/batch-l2-doc-error

Batch l2 doc error
f-dangel · Jan 20, 2020 · 4e7fed2 · 4e7fed2
2 parents bce5207 + b67b6a3
commit 4e7fed2
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/backpack/extensions/firstorder/batch_l2_grad/__init__.py b/backpack/extensions/firstorder/batch_l2_grad/__init__.py
@@ -7,7 +7,7 @@
 
 class BatchL2Grad(BackpropExtension):
     """
-    The L2 norm of individual gradients in the minibatch.
+    The squared L2 norm of individual gradients in the minibatch.
     Is only meaningful is the individual functions are independent (no batchnorm).
 
     Stores the output in :code:`batch_l2`

diff --git a/docs/rtd/extensions.html b/docs/rtd/extensions.html
@@ -168,7 +168,7 @@ <h2>First-order extensions<a class="headerlink" href="#first-order-extensions" t
 <dl class="function">
 <dt id="backpack.extensions.BatchL2Grad">
 <code class="sig-prename descclassname">backpack.extensions.</code><code class="sig-name descname">BatchL2Grad</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#backpack.extensions.BatchL2Grad" title="Permalink to this definition">¶</a></dt>
-<dd><p>The L2 norm of individual gradients in the minibatch.
+<dd><p>The squared L2 norm of individual gradients in the minibatch.
 Is only meaningful is the individual functions are independent (no batchnorm).</p>
 <p>Stores the output in <code class="code docutils literal notranslate"><span class="pre">batch_l2</span></code>
 as a vector of the size as the minibatch.</p>