Skip to content

Commit 806a406

Browse files
committed
update readme
1 parent 42d0aa9 commit 806a406

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
[![PyPI version](https://badge.fury.io/py/POT.svg)](https://badge.fury.io/py/POT)
44
[![Build Status](https://travis-ci.org/rflamary/POT.svg?branch=master)](https://travis-ci.org/rflamary/POT)
55
[![Documentation Status](https://readthedocs.org/projects/pot/badge/?version=latest)](http://pot.readthedocs.io/en/latest/?badge=latest)
6+
[![Anaconda Cloud](https://anaconda.org/conda-forge/pot/badges/version.svg)](https://anaconda.org/conda-forge/pot)
7+
[![License](https://anaconda.org/conda-forge/pot/badges/license.svg)](https://github.com/rflamary/POT/blob/master/LICENSE)
8+
[![Anaconda downloads](https://anaconda.org/conda-forge/pot/badges/downloads.svg)](https://anaconda.org/conda-forge/pot)
9+
10+
611

712

813
This open source Python library provide several solvers for optimization problems related to Optimal Transport for signal, image processing and machine learning.

docs/source/readme.rst

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
POT: Python Optimal Transport
22
=============================
33

4-
|PyPI version| |Build Status| |Documentation Status|
4+
|PyPI version| |Build Status| |Documentation Status| |Anaconda Cloud|
5+
|License| |Anaconda downloads|
56

67
This open source Python library provide several solvers for optimization
78
problems related to Optimal Transport for signal, image processing and
@@ -172,6 +173,10 @@ want a quick look:
172173
images <https://github.com/rflamary/POT/blob/master/notebooks/plot_otda_mapping_colors_images.ipynb>`__
173174
- `Wasserstein Discriminant
174175
Analysis <https://github.com/rflamary/POT/blob/master/notebooks/plot_WDA.ipynb>`__
176+
- `Gromov
177+
Wasserstein <https://github.com/rflamary/POT/blob/master/notebooks/plot_gromov.ipynb>`__
178+
- `Gromov Wasserstein
179+
Barycenter <https://github.com/rflamary/POT/blob/master/notebooks/plot_gromov_barycenter.ipynb>`__
175180

176181
You can also see the notebooks with `Jupyter
177182
nbviewer <https://nbviewer.jupyter.org/github/rflamary/POT/tree/master/notebooks/>`__.
@@ -192,6 +197,7 @@ The contributors to this library are:
192197
Gayraud <https://www.linkedin.com/in/nathalie-t-h-gayraud/?ppe=1>`__
193198
- `Stanislas Chambon <https://slasnista.github.io/>`__
194199
- `Antoine Rolet <https://arolet.github.io/>`__
200+
- Erwan Vautier (Gromov-Wasserstein)
195201

196202
This toolbox benefit a lot from open source research and we would like
197203
to thank the following persons for providing some code (in various
@@ -204,6 +210,20 @@ languages):
204210
- `Marco Cuturi <http://marcocuturi.net/>`__ (Sinkhorn Knopp in
205211
Matlab/Cuda)
206212

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

@@ -292,3 +312,9 @@ International Conference on Machine Learning (ICML). 2016.
292312
:target: https://travis-ci.org/rflamary/POT
293313
.. |Documentation Status| image:: https://readthedocs.org/projects/pot/badge/?version=latest
294314
:target: http://pot.readthedocs.io/en/latest/?badge=latest
315+
.. |Anaconda Cloud| image:: https://anaconda.org/conda-forge/pot/badges/version.svg
316+
:target: https://anaconda.org/conda-forge/pot
317+
.. |License| image:: https://anaconda.org/conda-forge/pot/badges/license.svg
318+
:target: https://github.com/rflamary/POT/blob/master/LICENSE
319+
.. |Anaconda downloads| image:: https://anaconda.org/conda-forge/pot/badges/downloads.svg
320+
:target: https://anaconda.org/conda-forge/pot

0 commit comments

Comments
 (0)