CircleCI update of dev docs (68).

TorchDR · May 4, 2024 · c7377ec · c7377ec
1 parent 53e0e90
commit c7377ec
Show file tree

Hide file tree

Showing 20 changed files with 461 additions and 286 deletions.
diff --git a/dev/_modules/index.html b/dev/_modules/index.html
@@ -15,7 +15,7 @@
         <script src="../_static/jquery.js?v=5d32c60e"></script>
         <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
         <script src="../_static/documentation_options.js?v=8e37ee27"></script>
-        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/doctools.js?v=9a2dae69"></script>
         <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />

diff --git a/dev/_modules/torchdr/affinity/_entropic.html b/dev/_modules/torchdr/affinity/_entropic.html
diff --git a/dev/_modules/torchdr/utils/_optim.html b/dev/_modules/torchdr/utils/_optim.html
@@ -15,7 +15,7 @@
         <script src="../../../_static/jquery.js?v=5d32c60e"></script>
         <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
         <script src="../../../_static/documentation_options.js?v=8e37ee27"></script>
-        <script src="../../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../../_static/doctools.js?v=9a2dae69"></script>
         <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
@@ -109,6 +109,7 @@ <h1>Source code for torchdr.utils._optim</h1><div class="highlight"><pre>
 <span class="p">):</span>
 <span class="w">    </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Performs a batched binary search to find the root of an increasing function f.</span>
+<span class="sd">    The domain of f is restricted to positive floats.</span>
 
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
@@ -150,11 +151,11 @@ <h1>Source code for torchdr.utils._optim</h1><div class="highlight"><pre>
         <span class="n">fm</span> <span class="o">=</span> <span class="n">f</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>
 
         <span class="k">if</span> <span class="n">verbose</span><span class="p">:</span>
-            <span class="n">mean_f</span> <span class="o">=</span> <span class="n">fm</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">()</span>
-            <span class="n">std_f</span> <span class="o">=</span> <span class="n">fm</span><span class="o">.</span><span class="n">std</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">()</span>
+            <span class="n">mean_f</span> <span class="o">=</span> <span class="n">fm</span><span class="o">.</span><span class="n">abs</span><span class="p">()</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">()</span>
+            <span class="n">std_f</span> <span class="o">=</span> <span class="n">fm</span><span class="o">.</span><span class="n">abs</span><span class="p">()</span><span class="o">.</span><span class="n">std</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">()</span>
             <span class="n">pbar</span><span class="o">.</span><span class="n">set_description</span><span class="p">(</span>
-                <span class="sa">f</span><span class="s2">&quot;f mean : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">mean_f</span><span class="p">)</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
-                <span class="sa">f</span><span class="s2">&quot;f std : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">std_f</span><span class="p">)</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
+                <span class="sa">f</span><span class="s2">&quot;|f| mean : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">mean_f</span><span class="p">)</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
+                <span class="sa">f</span><span class="s2">&quot;|f| std : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">std_f</span><span class="p">)</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
                 <span class="sa">f</span><span class="s2">&quot;begin mean : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">begin</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">())</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
                 <span class="sa">f</span><span class="s2">&quot;end mean : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">end</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">())</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2"> &quot;</span>
             <span class="p">)</span>
@@ -179,6 +180,7 @@ <h1>Source code for torchdr.utils._optim</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Performs a batched false position method to find the root</span>
 <span class="sd">    of an increasing function f.</span>
+<span class="sd">    The domain of f is restricted to positive floats.</span>
 
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
@@ -230,11 +232,11 @@ <h1>Source code for torchdr.utils._optim</h1><div class="highlight"><pre>
         <span class="n">fm</span> <span class="o">=</span> <span class="n">f</span><span class="p">(</span><span class="n">m</span><span class="p">)</span>
 
         <span class="k">if</span> <span class="n">verbose</span><span class="p">:</span>
-            <span class="n">mean_f</span> <span class="o">=</span> <span class="n">fm</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">()</span>
-            <span class="n">std_f</span> <span class="o">=</span> <span class="n">fm</span><span class="o">.</span><span class="n">std</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">()</span>
+            <span class="n">mean_f</span> <span class="o">=</span> <span class="n">fm</span><span class="o">.</span><span class="n">abs</span><span class="p">()</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">()</span>
+            <span class="n">std_f</span> <span class="o">=</span> <span class="n">fm</span><span class="o">.</span><span class="n">abs</span><span class="p">()</span><span class="o">.</span><span class="n">std</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">()</span>
             <span class="n">pbar</span><span class="o">.</span><span class="n">set_description</span><span class="p">(</span>
-                <span class="sa">f</span><span class="s2">&quot;f mean : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">mean_f</span><span class="p">)</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
-                <span class="sa">f</span><span class="s2">&quot;f std : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">std_f</span><span class="p">)</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
+                <span class="sa">f</span><span class="s2">&quot;|f| mean : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">mean_f</span><span class="p">)</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
+                <span class="sa">f</span><span class="s2">&quot;|f| std : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">std_f</span><span class="p">)</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
                 <span class="sa">f</span><span class="s2">&quot;begin mean : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">begin</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">())</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2">, &quot;</span>
                 <span class="sa">f</span><span class="s2">&quot;end mean : </span><span class="si">{</span><span class="nb">float</span><span class="p">(</span><span class="n">end</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span><span class="o">.</span><span class="n">item</span><span class="p">())</span><span class="si">:</span><span class="s2"> .2e</span><span class="si">}</span><span class="s2"> &quot;</span>
             <span class="p">)</span>

diff --git a/dev/_static/basic.css b/dev/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/dev/_static/doctools.js b/dev/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/dev/_static/language_data.js b/dev/_static/language_data.js
@@ -5,15 +5,15 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
 
 
-/* Non-minified version is copied as a separate JS file, is available */
+/* Non-minified version is copied as a separate JS file, if available */
 
 /**
  * Porter Stemmer