Skip to content

Commit cb187e2

Browse files
committed
better readme
1 parent 0b1667d commit cb187e2

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# POT: Python Optimal Transport library
2-
Python Optimal Transport library
32

4-
This Python library is an open source implementation of several functions that allow to solve optimal transport problems in Python.
3+
This open source Python library provide several solvers for optimization problems related to Optimal Transport for signal, image processing and machine learning.
54

65
It provides the following solvers:
76
* Linear program (LP) OT solver/ Earth Movers Distance (using code from Antoine Rolet and Nicolas Bonneel [1]).
87
* Entropic regularization OT solver with Sinkhorn Knopp Algorithm [2].
98
* Bregman projections for Wasserstein barycenter [3] and unmixing [4].
109
* Optimal transport for domain adaptation with group lasso regularization [5]
11-
* Conditional gradient and Generalized conditional gradient for regularized OT [5].
10+
* Conditional gradient [6] and Generalized conditional gradient for regularized OT [7].
1211

1312
Some demonstrations (both in Python and Jupyter Notebook Format) are available in the examples folder.
1413

@@ -18,6 +17,11 @@ Some demonstrations (both in Python and Jupyter Notebook Format) are available i
1817

1918
## Examples
2019

20+
The examples folder contain several examples abnd use case for the library. Here is a list of the Ypython notebook if you want a quick look.
21+
22+
* [1D Optimal transport](examples/Demo_1D_OT.ipynb)
23+
24+
2125
## Acknowledgements
2226

2327
The main developers of this library are:
@@ -44,3 +48,5 @@ This toolbox benefit a lot from Open Source research and we would like to thank
4448
[5] N. Courty; R. Flamary; D. Tuia; A. Rakotomamonjy, "Optimal Transport for Domain Adaptation," in IEEE Transactions on Pattern Analysis and Machine Intelligence , vol.PP, no.99, pp.1-1
4549

4650
[6] Ferradans, S., Papadakis, N., Peyré, G., & Aujol, J. F. (2014). Regularized discrete optimal transport. SIAM Journal on Imaging Sciences, 7(3), 1853-1882.
51+
52+
[7] Rakotomamonjy, A., Flamary, R., & Courty, N. (2015). Generalized conditional gradient: analysis of convergence and applications. arXiv preprint arXiv:1510.06567.

0 commit comments

Comments
 (0)