summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRĂ©mi Flamary <remi.flamary@gmail.com>2020-04-21 17:48:37 +0200
committerGitHub <noreply@github.com>2020-04-21 17:48:37 +0200
commita303cc6b483d3cd958c399621e22e40574bcbbc8 (patch)
treedea049cb692020462da8f00d9e117f93b839bb55 /README.md
parent0b2d808aaebb1cab60a272ea7901d5f77df43a9f (diff)
[MRG] Actually run sphinx-gallery (#146)
* generate gallery * remove mock * add sklearn to requirermnt?txt for example * remove latex from fgw example * add networks for graph example * remove all * add requirement.txt rtd * rtd debug * update readme * eradthedoc with redirection * add conf rtd
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 65193ff..40f43e0 100644
--- a/README.md
+++ b/README.md
@@ -5,16 +5,18 @@
[![Build Status](https://travis-ci.org/PythonOT/POT.svg?branch=master)](https://travis-ci.org/PythonOT/POT)
[![Build Status](https://github.com/PythonOT/POT/workflows/Linux%7CWin%7CMacOS/badge.svg)](https://github.com/PythonOT/POT/actions)
[![Codecov Status](https://codecov.io/gh/PythonOT/POT/branch/master/graph/badge.svg)](https://codecov.io/gh/PythonOT/POT)
-[![Documentation Status](https://readthedocs.org/projects/pot/badge/?version=latest)](http://pot.readthedocs.io/en/latest/?badge=latest)
[![Downloads](https://pepy.tech/badge/pot)](https://pepy.tech/project/pot)
[![Anaconda downloads](https://anaconda.org/conda-forge/pot/badges/downloads.svg)](https://anaconda.org/conda-forge/pot)
[![License](https://anaconda.org/conda-forge/pot/badges/license.svg)](https://github.com/PythonOT/POT/blob/master/LICENSE)
+This open source Python library provide several solvers for optimization
+problems related to Optimal Transport for signal, image processing and machine
+learning.
-This open source Python library provide several solvers for optimization problems related to Optimal Transport for signal, image processing and machine learning.
+Website and documentation: [https://PythonOT.github.io/](https://PythonOT.github.io/)
-It provides the following solvers:
+POT provides the following solvers:
* OT Network Flow solver for the linear program/ Earth Movers Distance [1].
* Entropic regularization OT solver with Sinkhorn Knopp Algorithm [2], stabilized version [9][10] and greedy Sinkhorn [22] with optional GPU implementation (requires cupy).
@@ -139,7 +141,7 @@ ba=ot.barycenter(A,M,reg) # reg is regularization parameter
### Examples and Notebooks
-The examples folder contain several examples and use case for the library. The full documentation is available on [Readthedocs](http://pot.readthedocs.io/).
+The examples folder contain several examples and use case for the library. The full documentation is available on [https://PythonOT.github.io/](https://PythonOT.github.io/).
Here is a list of the Python notebooks available [here](https://github.com/PythonOT/POT/blob/master/notebooks/) if you want a quick look: