add Lorentz to docs (#134)

* add Lorentz to docs * fix the link * fix the link
geoopt · Jun 1, 2020 · 7a61c52 · 7a61c52
1 parent b227ccc
commit 7a61c52
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -80,6 +80,7 @@ Manifolds
 -  ``geoopt.Stereographic`` - Constant curvature stereographic projection model
 -  ``geoopt.SphereProjection`` - Sphere stereographic projection model
 -  ``geoopt.PoincareBall`` - Poincare ball model (`wiki <https://en.wikipedia.org/wiki/Poincar%C3%A9_disk_model>`_)
+-  ``geoopt.Lorentz`` - Hyperboloid model (`wiki <https://en.wikipedia.org/wiki/Hyperboloid_model>`_)
 -  ``geoopt.ProductManifold`` - Product manifold constructor
 -  ``geoopt.Scaled`` - Scaled version of the manifold. Similar to `Learning Mixed-Curvature Representations in Product Spaces <https://openreview.net/forum?id=HJxeWnCcF7>`_ if combined with ``ProductManifold``
 

diff --git a/docs/manifolds.rst b/docs/manifolds.rst
@@ -7,6 +7,6 @@ Manifolds
 All manifolds share same API. Some manifols may have several implementations of retraction operation, every implementation has a corresponding class.
 
 .. automodule:: geoopt.manifolds
-    :members: Euclidean, Stiefel, CanonicalStiefel, EuclideanStiefel, EuclideanStiefelExact, Sphere, SphereExact, Stereographic, StereographicExact, PoincareBall, PoincareBallExact, SphereProjection, SphereProjectionExact, Scaled, ProductManifold
+    :members: Euclidean, Stiefel, CanonicalStiefel, EuclideanStiefel, EuclideanStiefelExact, Sphere, SphereExact, Stereographic, StereographicExact, PoincareBall, PoincareBallExact, SphereProjection, SphereProjectionExact, Scaled, ProductManifold, Lorentz