Skip to content

Commit

Permalink
add doc notes
Browse files Browse the repository at this point in the history
  • Loading branch information
ferrine committed Feb 13, 2019
1 parent 583e7ef commit 6212291
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ New Features
------------
* Added ``Sphere`` manifold (#25)
* Added ``SphereSubspaceIntersection``, ``SphereSubspaceComplementIntersection`` manifolds (#29)
* Added expmap implementation (#43)

Maintenance
-----------
Expand Down
7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ points on a certain manifold
projected, they are assumed to be already projected.
- ``.retr(u, t=1.)`` – retraction map following vector ``u`` for time
``t``
- ``.expmap(u, t=1.)`` – exponential map following vector ``u`` for time
``t`` (if expmap is not available in closed form, best approximation is used)
- ``.transp(v, *more, u, t=1.)`` – transport vector ``v`` (and possibly
more vectors) with direction ``u`` for time ``t``
- ``.retr_transp(v, *more, u, t=1.)`` – transport ``self``, vector ``v``
Expand All @@ -71,6 +73,9 @@ Manifolds
``A in R^{n x p} : A^t A=I``, ``n >= p``
- ``geoopt.Sphere`` - Sphere manifold ``||x||=1``

All manifolds implement methods necessary to manipulate tensors on manifolds and
tangent vectors to be used in general purpose. See more in `documentation`_.

Optimizers
~~~~~~~~~~

Expand All @@ -88,6 +93,8 @@ Samplers
Hamiltonian Monte-Carlo

.. _“Riemannian Adaptive Optimization Methods”: https://openreview.net/forum?id=r1eiqi09K7
.. _documentation: https://geoopt.readthedocs.io/en/latest/manifolds.html


.. |Python Package Index| image:: https://img.shields.io/pypi/v/geoopt.svg
:target: https://pypi.python.org/pypi/geoopt
Expand Down

0 comments on commit 6212291

Please sign in to comment.