summaryrefslogtreecommitdiff
path: root/docs/source/readme.rst
diff options
context:
space:
mode:
authorRémi Flamary <remi.flamary@gmail.com>2017-04-20 15:40:25 +0200
committerRémi Flamary <remi.flamary@gmail.com>2017-04-20 15:40:25 +0200
commit2cc2f069b9241efdf2d0e0be1f7fbb6e6ab9dc45 (patch)
tree77e0a09f37559d390691b84a75161d9b88b5922d /docs/source/readme.rst
parentdabb16cd6601b92c5d6b8854c361ccf7343d96af (diff)
update doc
Diffstat (limited to 'docs/source/readme.rst')
-rw-r--r--docs/source/readme.rst26
1 files changed, 25 insertions, 1 deletions
diff --git a/docs/source/readme.rst b/docs/source/readme.rst
index e1d4459..13cf572 100644
--- a/docs/source/readme.rst
+++ b/docs/source/readme.rst
@@ -47,7 +47,7 @@ it) on you machine using
::
- python setup.py install --user
+ python setup.py install --user # for user install (no root)
The toolbox is also available on PyPI with a possibly slightly older
version. You can install it with:
@@ -65,6 +65,28 @@ without errors:
Note that for easier access the module is name ot instead of pot.
+Dependencies
+~~~~~~~~~~~~
+
+Some sub-modules require additional dependences which are discussed
+below
+
+- ot.dr (Wasserstein dimensionality rediuction) depends on autograd and
+ pymanopt that can be installed with:
+
+ ::
+
+ pip install pymanopt autograd
+
+- ot.gpu (GPU accelerated OT) depends on cudamat that have to be
+ installed with:
+
+ ::
+
+ git clone https://github.com/cudamat/cudamat.git
+ cd cudamat
+ python setup.py install --user # for user install (no root)
+
Examples
--------
@@ -103,6 +125,8 @@ The contributors to this library are:
- `Nicolas Courty <http://people.irisa.fr/Nicolas.Courty/>`__
- `Laetitia Chapel <http://people.irisa.fr/Laetitia.Chapel/>`__
- `Michael Perrot <http://perso.univ-st-etienne.fr/pem82055/>`__
+ (Mapping estimation)
+- `Léo Gautheron <https://github.com/aje>`__ (GPU implementation)
This toolbox benefit a lot from open source research and we would like
to thank the following persons for providing some code (in various