Skip to content

Commit 2cc2f06

Browse files
committed
update doc
1 parent dabb16c commit 2cc2f06

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/source/readme.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ it) on you machine using
4747

4848
::
4949

50-
python setup.py install --user
50+
python setup.py install --user # for user install (no root)
5151

5252
The toolbox is also available on PyPI with a possibly slightly older
5353
version. You can install it with:
@@ -65,6 +65,28 @@ without errors:
6565
6666
Note that for easier access the module is name ot instead of pot.
6767

68+
Dependencies
69+
~~~~~~~~~~~~
70+
71+
Some sub-modules require additional dependences which are discussed
72+
below
73+
74+
- ot.dr (Wasserstein dimensionality rediuction) depends on autograd and
75+
pymanopt that can be installed with:
76+
77+
::
78+
79+
pip install pymanopt autograd
80+
81+
- ot.gpu (GPU accelerated OT) depends on cudamat that have to be
82+
installed with:
83+
84+
::
85+
86+
git clone https://github.com/cudamat/cudamat.git
87+
cd cudamat
88+
python setup.py install --user # for user install (no root)
89+
6890
Examples
6991
--------
7092

@@ -103,6 +125,8 @@ The contributors to this library are:
103125
- `Nicolas Courty <http://people.irisa.fr/Nicolas.Courty/>`__
104126
- `Laetitia Chapel <http://people.irisa.fr/Laetitia.Chapel/>`__
105127
- `Michael Perrot <http://perso.univ-st-etienne.fr/pem82055/>`__
128+
(Mapping estimation)
129+
- `Léo Gautheron <https://github.com/aje>`__ (GPU implementation)
106130

107131
This toolbox benefit a lot from open source research and we would like
108132
to thank the following persons for providing some code (in various

0 commit comments

Comments
 (0)