refactor docs page and tutorials

kornia · Jan 9, 2019 · 06bdd03 · 06bdd03
1 parent d0c7658
commit 06bdd03
Show file tree

Hide file tree

Showing 49 changed files with 6,627 additions and 1,532 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
diff --git a/docs/build/html/_images/warp_affine_4_1.png b/docs/build/html/_images/warp_affine_4_1.png
diff --git a/docs/build/html/_images/warp_perspective_4_1.png b/docs/build/html/_images/warp_perspective_4_1.png
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; Torchgeometry master documentation</title>
+  <title>Overview: module code &mdash; PyTorch Geometry master documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                master (0.1.0 )
+                master (0.1.2rc1 )
               </div>
 
 
@@ -85,8 +85,21 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Package Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../geometric.html">Geometric Image Transformations</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../pinhole.html">Pinhole</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../conversions.html">Conversions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../warping.html">Warping</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../image.html">torchgeometry.image</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../utils.html">torchgeometry.utils</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../warp_affine.html">Rotate image using warp affine transform</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../warp_perspective.html">Warp image using perspective transform</a></li>
+</ul>
+
 
 
         </div>
@@ -99,7 +112,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../index.html">Torchgeometry</a>
+          <a href="../index.html">PyTorch Geometry</a>
 
       </nav>
 
@@ -149,6 +162,7 @@ <h1>All modules for which code is available</h1>
 <ul><li><a href="torchgeometry/conversions.html">torchgeometry.conversions</a></li>
 <li><a href="torchgeometry/depth_warper.html">torchgeometry.depth_warper</a></li>
 <li><a href="torchgeometry/homography_warper.html">torchgeometry.homography_warper</a></li>
+<li><a href="torchgeometry/image/gaussian.html">torchgeometry.image.gaussian</a></li>
 <li><a href="torchgeometry/imgwarp.html">torchgeometry.imgwarp</a></li>
 <li><a href="torchgeometry/pinhole.html">torchgeometry.pinhole</a></li>
 <li><a href="torchgeometry/utils.html">torchgeometry.utils</a></li>
@@ -190,6 +204,7 @@ <h1>All modules for which code is available</h1>
         <script type="text/javascript" src="../_static/underscore.js"></script>
         <script type="text/javascript" src="../_static/doctools.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+        <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
 
 
 

diff --git a/docs/build/html/_modules/torchgeometry/conversions.html b/docs/build/html/_modules/torchgeometry/conversions.html
diff --git a/docs/build/html/_modules/torchgeometry/depth_warper.html b/docs/build/html/_modules/torchgeometry/depth_warper.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>torchgeometry.depth_warper &mdash; Torchgeometry master documentation</title>
+  <title>torchgeometry.depth_warper &mdash; PyTorch Geometry master documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                master (0.1.0 )
+                master (0.1.2rc1 )
               </div>
 
 
@@ -85,8 +85,21 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Package Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../geometric.html">Geometric Image Transformations</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../pinhole.html">Pinhole</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../conversions.html">Conversions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../warping.html">Warping</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../image.html">torchgeometry.image</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../utils.html">torchgeometry.utils</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../warp_affine.html">Rotate image using warp affine transform</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../warp_perspective.html">Warp image using perspective transform</a></li>
+</ul>
+
 
 
         </div>
@@ -99,7 +112,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../index.html">Torchgeometry</a>
+          <a href="../../index.html">PyTorch Geometry</a>
 
       </nav>
 
@@ -161,7 +174,7 @@ <h1>Source code for torchgeometry.depth_warper</h1><div class="highlight"><pre>
 <span class="p">]</span>
 
 
-<div class="viewcode-block" id="DepthWarper"><a class="viewcode-back" href="../../index.html#torchgeometry.DepthWarper">[docs]</a><span class="k">class</span> <span class="nc">DepthWarper</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+<div class="viewcode-block" id="DepthWarper"><a class="viewcode-back" href="../../warping.html#torchgeometry.DepthWarper">[docs]</a><span class="k">class</span> <span class="nc">DepthWarper</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="sd">&quot;&quot;&quot;Warps a patch by inverse depth.</span>
 
 <span class="sd">    .. math::</span>
@@ -210,7 +223,7 @@ <h1>Source code for torchgeometry.depth_warper</h1><div class="highlight"><pre>
         <span class="n">y</span> <span class="o">=</span> <span class="p">(</span><span class="n">flow</span><span class="p">[:,</span> <span class="p">:,</span> <span class="mi">1</span><span class="p">]</span> <span class="o">*</span> <span class="n">z</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">stack</span><span class="p">([</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">],</span> <span class="mi">1</span><span class="p">)</span>
 
-<div class="viewcode-block" id="DepthWarper.compute_subpixel_step"><a class="viewcode-back" href="../../index.html#torchgeometry.DepthWarper.compute_subpixel_step">[docs]</a>    <span class="k">def</span> <span class="nf">compute_subpixel_step</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<div class="viewcode-block" id="DepthWarper.compute_subpixel_step"><a class="viewcode-back" href="../../warping.html#torchgeometry.DepthWarper.compute_subpixel_step">[docs]</a>    <span class="k">def</span> <span class="nf">compute_subpixel_step</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;This computes the required inverse depth step to achieve sub pixel</span>
 <span class="sd">accurate sampling of the depth cost volume, per camera.</span>
 <span class="sd">        Szeliski, Richard, and Daniel Scharstein.</span>
@@ -279,7 +292,7 @@ <h1>Source code for torchgeometry.depth_warper</h1><div class="highlight"><pre>
         <span class="n">flows</span> <span class="o">=</span> <span class="n">flow</span><span class="o">.</span><span class="n">view</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="n">c</span><span class="p">,</span> <span class="n">height</span><span class="p">,</span> <span class="n">width</span><span class="p">)</span>  <span class="c1"># Nx2xHxW</span>
         <span class="k">return</span> <span class="n">flows</span><span class="o">.</span><span class="n">permute</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>  <span class="c1"># NxHxWx2</span>
 
-<div class="viewcode-block" id="DepthWarper.forward"><a class="viewcode-back" href="../../index.html#torchgeometry.DepthWarper.forward">[docs]</a>    <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inv_depth_ref</span><span class="p">,</span> <span class="n">patch_i</span><span class="p">):</span>
+<div class="viewcode-block" id="DepthWarper.forward"><a class="viewcode-back" href="../../warping.html#torchgeometry.DepthWarper.forward">[docs]</a>    <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inv_depth_ref</span><span class="p">,</span> <span class="n">patch_i</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Warps an image or tensor from ith frame to reference given the</span>
 <span class="sd">        inverse depth in the reference frame.</span>
 
@@ -314,7 +327,7 @@ <h1>Source code for torchgeometry.depth_warper</h1><div class="highlight"><pre>
 
 <span class="c1"># functional api</span>
 
-<div class="viewcode-block" id="depth_warp"><a class="viewcode-back" href="../../index.html#torchgeometry.depth_warp">[docs]</a><span class="k">def</span> <span class="nf">depth_warp</span><span class="p">(</span><span class="n">pinholes_i</span><span class="p">,</span> <span class="n">pinhole_ref</span><span class="p">,</span> <span class="n">inv_depth_ref</span><span class="p">,</span> <span class="n">patch_i</span><span class="p">,</span>
+<div class="viewcode-block" id="depth_warp"><a class="viewcode-back" href="../../warping.html#torchgeometry.depth_warp">[docs]</a><span class="k">def</span> <span class="nf">depth_warp</span><span class="p">(</span><span class="n">pinholes_i</span><span class="p">,</span> <span class="n">pinhole_ref</span><span class="p">,</span> <span class="n">inv_depth_ref</span><span class="p">,</span> <span class="n">patch_i</span><span class="p">,</span>
                <span class="n">width</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">height</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    .. note::</span>
@@ -385,6 +398,7 @@ <h1>Source code for torchgeometry.depth_warper</h1><div class="highlight"><pre>
         <script type="text/javascript" src="../../_static/underscore.js"></script>
         <script type="text/javascript" src="../../_static/doctools.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+        <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
 
 
 

diff --git a/docs/build/html/_modules/torchgeometry/homography_warper.html b/docs/build/html/_modules/torchgeometry/homography_warper.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>torchgeometry.homography_warper &mdash; Torchgeometry master documentation</title>
+  <title>torchgeometry.homography_warper &mdash; PyTorch Geometry master documentation</title>
 
 
 
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                master (0.1.0 )
+                master (0.1.2rc1 )
               </div>
 
 
@@ -85,8 +85,21 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Package Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../geometric.html">Geometric Image Transformations</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../pinhole.html">Pinhole</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../conversions.html">Conversions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../warping.html">Warping</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../image.html">torchgeometry.image</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../utils.html">torchgeometry.utils</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Tutorials</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../warp_affine.html">Rotate image using warp affine transform</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../warp_perspective.html">Warp image using perspective transform</a></li>
+</ul>
+
 
 
         </div>
@@ -99,7 +112,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="../../index.html">Torchgeometry</a>
+          <a href="../../index.html">PyTorch Geometry</a>
 
       </nav>
 
@@ -164,7 +177,7 @@ <h1>Source code for torchgeometry.homography_warper</h1><div class="highlight"><
 
 <span class="c1"># layer api</span>
 
-<div class="viewcode-block" id="HomographyWarper"><a class="viewcode-back" href="../../index.html#torchgeometry.HomographyWarper">[docs]</a><span class="k">class</span> <span class="nc">HomographyWarper</span><span class="p">(</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+<div class="viewcode-block" id="HomographyWarper"><a class="viewcode-back" href="../../warping.html#torchgeometry.HomographyWarper">[docs]</a><span class="k">class</span> <span class="nc">HomographyWarper</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="sd">&quot;&quot;&quot;Warps patches by homographies.</span>
 
 <span class="sd">    .. math::</span>
@@ -192,7 +205,7 @@ <h1>Source code for torchgeometry.homography_warper</h1><div class="highlight"><
             <span class="bp">self</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="n">create_meshgrid</span><span class="p">(</span>
                 <span class="n">height</span><span class="p">,</span> <span class="n">width</span><span class="p">,</span> <span class="n">normalized_coordinates</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
-<div class="viewcode-block" id="HomographyWarper.warp_grid"><a class="viewcode-back" href="../../index.html#torchgeometry.HomographyWarper.warp_grid">[docs]</a>    <span class="k">def</span> <span class="nf">warp_grid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">H</span><span class="p">):</span>
+<div class="viewcode-block" id="HomographyWarper.warp_grid"><a class="viewcode-back" href="../../warping.html#torchgeometry.HomographyWarper.warp_grid">[docs]</a>    <span class="k">def</span> <span class="nf">warp_grid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">H</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        :param H: Homography or homographies (stacked) to transform all points</span>
 <span class="sd">                  in the grid.</span>
@@ -240,7 +253,7 @@ <h1>Source code for torchgeometry.homography_warper</h1><div class="highlight"><
         <span class="k">return</span> <span class="n">F</span><span class="o">.</span><span class="n">grid_sample</span><span class="p">(</span>
             <span class="n">image</span><span class="p">,</span> <span class="n">grid</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">&#39;bilinear&#39;</span><span class="p">,</span> <span class="n">padding_mode</span><span class="o">=</span><span class="n">padding_mode</span><span class="p">)</span>
 
-<div class="viewcode-block" id="HomographyWarper.forward"><a class="viewcode-back" href="../../index.html#torchgeometry.HomographyWarper.forward">[docs]</a>    <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">patch</span><span class="p">,</span> <span class="n">dst_homo_src</span><span class="p">,</span> <span class="n">padding_mode</span><span class="o">=</span><span class="s1">&#39;zeros&#39;</span><span class="p">):</span>
+<div class="viewcode-block" id="HomographyWarper.forward"><a class="viewcode-back" href="../../warping.html#torchgeometry.HomographyWarper.forward">[docs]</a>    <span class="k">def</span> <span class="nf">forward</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">patch</span><span class="p">,</span> <span class="n">dst_homo_src</span><span class="p">,</span> <span class="n">padding_mode</span><span class="o">=</span><span class="s1">&#39;zeros&#39;</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Warps an image or tensor from source into reference frame.</span>
 
 <span class="sd">        Args:</span>
@@ -275,7 +288,7 @@ <h1>Source code for torchgeometry.homography_warper</h1><div class="highlight"><
 <span class="c1"># functional api</span>
 
 
-<div class="viewcode-block" id="homography_warp"><a class="viewcode-back" href="../../index.html#torchgeometry.homography_warp">[docs]</a><span class="k">def</span> <span class="nf">homography_warp</span><span class="p">(</span><span class="n">patch</span><span class="p">,</span> <span class="n">dst_H_src</span><span class="p">,</span> <span class="n">dsize</span><span class="p">,</span> <span class="n">points</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+<div class="viewcode-block" id="homography_warp"><a class="viewcode-back" href="../../warping.html#torchgeometry.homography_warp">[docs]</a><span class="k">def</span> <span class="nf">homography_warp</span><span class="p">(</span><span class="n">patch</span><span class="p">,</span> <span class="n">dst_H_src</span><span class="p">,</span> <span class="n">dsize</span><span class="p">,</span> <span class="n">points</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                     <span class="n">padding_mode</span><span class="o">=</span><span class="s1">&#39;zeros&#39;</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    .. note:: Functional API for :class:`torgeometry.HomographyWarper`</span>
@@ -346,6 +359,7 @@ <h1>Source code for torchgeometry.homography_warper</h1><div class="highlight"><
         <script type="text/javascript" src="../../_static/underscore.js"></script>
         <script type="text/javascript" src="../../_static/doctools.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+        <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>