Skip to content

Commit 89bf69a

Browse files
committed
Add docs from pypose/pypose
1 parent c3054ee commit 89bf69a

File tree

12 files changed

+1077
-6
lines changed

12 files changed

+1077
-6
lines changed

docs/main/_modules/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,7 @@ <h1>All modules for which code is available</h1>
254254
<li><a href="pypose/module/ekf/">pypose.module.ekf</a></li>
255255
<li><a href="pypose/module/icp/">pypose.module.icp</a></li>
256256
<li><a href="pypose/module/imu_preintegrator/">pypose.module.imu_preintegrator</a></li>
257+
<li><a href="pypose/module/loss/">pypose.module.loss</a></li>
257258
<li><a href="pypose/module/lqr/">pypose.module.lqr</a></li>
258259
<li><a href="pypose/module/mpc/">pypose.module.mpc</a></li>
259260
<li><a href="pypose/module/pf/">pypose.module.pf</a></li>

docs/main/_modules/pypose/module/loss/index.html

Lines changed: 533 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. currentmodule:: pypose.module
2+
3+
4+
pypose.module.GeodesicLoss
5+
==========================
6+
7+
.. autoclass:: GeodesicLoss
8+
:members:

docs/main/_sources/modules.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ Modules
1919
module.EPnP
2020
module.MPC
2121
module.ICP
22+
module.GeodesicLoss

docs/main/generated/pypose.module.GeodesicLoss/index.html

Lines changed: 520 additions & 0 deletions
Large diffs are not rendered by default.

docs/main/generated/pypose.module.ICP/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
<link rel="stylesheet" href="../../_static/katex-math.css" type="text/css" />
3535
<link rel="index" title="Index" href="../../genindex/" />
3636
<link rel="search" title="Search" href="../../search/" />
37-
<link rel="next" title="Optimization" href="../../optim/" />
37+
<link rel="next" title="pypose.module.GeodesicLoss" href="../pypose.module.GeodesicLoss/" />
3838
<link rel="prev" title="pypose.module.MPC" href="../pypose.module.MPC/" />
3939

4040
<!--
@@ -354,7 +354,7 @@ <h1>pypose.module.ICP<a class="headerlink" href="#pypose-module-icp" title="Perm
354354

355355
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
356356

357-
<a href="../../optim/" class="btn btn-neutral float-right" title="Optimization" accesskey="n" rel="next">Next <img src="../../_static/images/chevron-right-orange.svg" class="next-page"></a>
357+
<a href="../pypose.module.GeodesicLoss/" class="btn btn-neutral float-right" title="pypose.module.GeodesicLoss" accesskey="n" rel="next">Next <img src="../../_static/images/chevron-right-orange.svg" class="next-page"></a>
358358

359359

360360
<a href="../pypose.module.MPC/" class="btn btn-neutral" title="pypose.module.MPC" accesskey="p" rel="prev"><img src="../../_static/images/chevron-right-orange.svg" class="previous-page"> Previous</a>

docs/main/genindex/index.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,8 @@ <h2 id="F">F</h2>
445445

446446
<ul>
447447
<li><a href="../generated/pypose.module.EPnP/#pypose.module.EPnP.forward">(pypose.module.EPnP method)</a>
448+
</li>
449+
<li><a href="../generated/pypose.module.GeodesicLoss/#pypose.module.GeodesicLoss.forward">(pypose.module.GeodesicLoss method)</a>
448450
</li>
449451
<li><a href="../generated/pypose.module.ICP/#pypose.module.ICP.forward">(pypose.module.ICP method)</a>
450452
</li>
@@ -504,10 +506,12 @@ <h2 id="G">G</h2>
504506
<table style="width: 100%" class="indextable genindextable"><tr>
505507
<td style="width: 33%; vertical-align: top;"><ul>
506508
<li><a href="../generated/pypose.optim.GaussNewton/#pypose.optim.GaussNewton">GaussNewton (class in pypose.optim)</a>
509+
</li>
510+
<li><a href="../generated/pypose.module.PF/#pypose.module.PF.generate_particles">generate_particles() (pypose.module.PF method)</a>
507511
</li>
508512
</ul></td>
509513
<td style="width: 33%; vertical-align: top;"><ul>
510-
<li><a href="../generated/pypose.module.PF/#pypose.module.PF.generate_particles">generate_particles() (pypose.module.PF method)</a>
514+
<li><a href="../generated/pypose.module.GeodesicLoss/#pypose.module.GeodesicLoss">GeodesicLoss (class in pypose.module)</a>
511515
</li>
512516
<li><a href="../generated/pypose.optim.GN/#pypose.optim.GN">GN (in module pypose.optim)</a>
513517
</li>

docs/main/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,7 @@ <h1>PyPose Documentation<a class="headerlink" href="#pypose-documentation" title
354354
<li class="toctree-l2"><a class="reference internal" href="generated/pypose.module.EPnP/">pypose.module.EPnP</a></li>
355355
<li class="toctree-l2"><a class="reference internal" href="generated/pypose.module.MPC/">pypose.module.MPC</a></li>
356356
<li class="toctree-l2"><a class="reference internal" href="generated/pypose.module.ICP/">pypose.module.ICP</a></li>
357+
<li class="toctree-l2"><a class="reference internal" href="generated/pypose.module.GeodesicLoss/">pypose.module.GeodesicLoss</a></li>
357358
</ul>
358359
</li>
359360
<li class="toctree-l1"><a class="reference internal" href="optim/">Optimization</a><ul>

docs/main/modules/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,9 @@ <h1>Modules<a class="headerlink" href="#modules" title="Permalink to this headin
285285
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pypose.module.ICP/#pypose.module.ICP" title="pypose.module.ICP"><code class="xref py py-obj docutils literal notranslate"><span class="pre">module.ICP</span></code></a></p></td>
286286
<td><p>Batched Iterative Closest Point (ICP) algorithm to find a rigid transformation between two sets of points using Singular Value Decomposition (SVD).</p></td>
287287
</tr>
288+
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pypose.module.GeodesicLoss/#pypose.module.GeodesicLoss" title="pypose.module.GeodesicLoss"><code class="xref py py-obj docutils literal notranslate"><span class="pre">module.GeodesicLoss</span></code></a></p></td>
289+
<td><p>Creates a criterion that measures the Geodesic Error between the rotation part of the input LieTensor <span class="math">\(x\)</span> and target LieTensor <span class="math">\(y\)</span>.</p></td>
290+
</tr>
288291
</tbody>
289292
</table>
290293
</section>

docs/main/objects.inv

46 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)