Skip to content

Commit dabb16c

Browse files
committed
add dependencies discussion in readme
1 parent 44b8462 commit dabb16c

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ sudo apt-get install python-numpy python-scipy python-matplotlib cython
3737

3838
To install the library, you can install it locally (after downloading it) on you machine using
3939
```
40-
python setup.py install --user
40+
python setup.py install --user # for user install (no root)
4141
```
4242

4343
The toolbox is also available on PyPI with a possibly slightly older version. You can install it with:
@@ -52,6 +52,22 @@ import ot
5252

5353
Note that for easier access the module is name ot instead of pot.
5454

55+
56+
### Dependencies
57+
58+
Some sub-modules require additional dependences which are discussed below
59+
60+
* ot.dr (Wasserstein dimensionality rediuction) depends on autograd and pymanopt that can be installed with:
61+
```
62+
pip install pymanopt autograd
63+
```
64+
* ot.gpu (GPU accelerated OT) depends on cudamat that have to be installed with:
65+
```
66+
git clone https://github.com/cudamat/cudamat.git
67+
cd cudamat
68+
python setup.py install --user # for user install (no root)
69+
```
70+
5571
## Examples
5672

5773
The examples folder contain several examples and use case for the library. The full documentation is available on [Readthedocs](http://pot.readthedocs.io/)
@@ -77,8 +93,8 @@ The contributors to this library are:
7793
* [Rémi Flamary](http://remi.flamary.com/)
7894
* [Nicolas Courty](http://people.irisa.fr/Nicolas.Courty/)
7995
* [Laetitia Chapel](http://people.irisa.fr/Laetitia.Chapel/)
80-
* [Michael Perrot](http://perso.univ-st-etienne.fr/pem82055/)
81-
* [Léo Gautheron](https://github.com/aje)
96+
* [Michael Perrot](http://perso.univ-st-etienne.fr/pem82055/) (Mapping estimation)
97+
* [Léo Gautheron](https://github.com/aje) (GPU implementation)
8298

8399
This toolbox benefit a lot from open source research and we would like to thank the following persons for providing some code (in various languages):
84100

0 commit comments

Comments
 (0)