Skip to content

Commit 77d80f8

Browse files
committed
update documentation
1 parent 927ec79 commit 77d80f8

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

docs/source/readme.rst

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ It provides the following solvers:
1414
[1].
1515
- Entropic regularization OT solver with Sinkhorn Knopp Algorithm [2]
1616
and stabilized version [9][10] with optional GPU implementation
17-
(required cudamat).
17+
(requires cudamat).
18+
- Smooth optimal transport solvers (dual and semi-dual) for KL and
19+
squared L2 regularizations [17].
20+
- Non regularized Wasserstein barycenters [16] with LP solver (only
21+
small scale).
1822
- Bregman projections for Wasserstein barycenter [3] and unmixing [4].
1923
- Optimal transport for domain adaptation with group lasso
2024
regularization [5]
@@ -29,6 +33,21 @@ It provides the following solvers:
2933
Some demonstrations (both in Python and Jupyter Notebook format) are
3034
available in the examples folder.
3135

36+
Using and citing the toolbox
37+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
38+
39+
If you use this toolbox in your research and find it useful, please cite
40+
POT using the following bibtex reference:
41+
42+
::
43+
44+
@misc{flamary2017pot,
45+
title={POT Python Optimal Transport library},
46+
author={Flamary, R{'e}mi and Courty, Nicolas},
47+
url={https://github.com/rflamary/POT},
48+
year={2017}
49+
}
50+
3251
Installation
3352
------------
3453

@@ -37,7 +56,7 @@ C++ compiler for using the EMD solver and relies on the following Python
3756
modules:
3857

3958
- Numpy (>=1.11)
40-
- Scipy (>=0.17)
59+
- Scipy (>=1.0)
4160
- Cython (>=0.23)
4261
- Matplotlib (>=1.5)
4362

@@ -212,20 +231,6 @@ languages):
212231
- `Marco Cuturi <http://marcocuturi.net/>`__ (Sinkhorn Knopp in
213232
Matlab/Cuda)
214233

215-
Using and citing the toolbox
216-
----------------------------
217-
218-
If you use this toolbox in your research and find it useful, please cite
219-
POT using the following bibtex reference:
220-
221-
::
222-
223-
@article{flamary2017pot,
224-
title={POT Python Optimal Transport library},
225-
author={Flamary, R{\'e}mi and Courty, Nicolas},
226-
year={2017}
227-
}
228-
229234
Contributions and code of conduct
230235
---------------------------------
231236

@@ -320,6 +325,15 @@ Journal of Optimization Theory and Applications Vol 43.
320325
[15] Peyré, G., & Cuturi, M. (2018). `Computational Optimal
321326
Transport <https://arxiv.org/pdf/1803.00567.pdf>`__ .
322327

328+
[16] Agueh, M., & Carlier, G. (2011). `Barycenters in the Wasserstein
329+
space <https://hal.archives-ouvertes.fr/hal-00637399/document>`__. SIAM
330+
Journal on Mathematical Analysis, 43(2), 904-924.
331+
332+
[17] Blondel, M., Seguy, V., & Rolet, A. (2018). `Smooth and Sparse
333+
Optimal Transport <https://arxiv.org/abs/1710.06276>`__. Proceedings of
334+
the Twenty-First International Conference on Artificial Intelligence and
335+
Statistics (AISTATS).
336+
323337
.. |PyPI version| image:: https://badge.fury.io/py/POT.svg
324338
:target: https://badge.fury.io/py/POT
325339
.. |Anaconda Cloud| image:: https://anaconda.org/conda-forge/pot/badges/version.svg

0 commit comments

Comments
 (0)