From 8fd50a7e9d0e7d06ea93fe6ad88413abc91ac6f9 Mon Sep 17 00:00:00 2001 From: RĂ©mi Flamary Date: Wed, 22 Apr 2020 14:15:15 +0200 Subject: relative path in doc --- Makefile | 1 + docs/source/readme.rst | 54 +++++++++++++++++++++++++------------------------- 2 files changed, 28 insertions(+), 27 deletions(-) diff --git a/Makefile b/Makefile index cafda8e..f5f89d9 100644 --- a/Makefile +++ b/Makefile @@ -58,6 +58,7 @@ release_test : rdoc : pandoc --from=markdown --to=rst --output=docs/source/readme.rst README.md + sed -i 's,https://pythonot.github.io/auto_examples/,auto_examples/,g' docs/source/readme.rst notebook : ipython notebook --matplotlib=inline --notebook-dir=notebooks/ diff --git a/docs/source/readme.rst b/docs/source/readme.rst index 4862523..b00d7b7 100644 --- a/docs/source/readme.rst +++ b/docs/source/readme.rst @@ -15,82 +15,82 @@ Source Code (MIT): https://github.com/PythonOT/POT POT provides the following generic OT solvers (links to examples): - `OT Network Simplex - solver `__ + solver `__ for the linear program/ Earth Movers Distance [1] . - `Conditional - gradient `__ + gradient `__ [6] and `Generalized conditional - gradient `__ + gradient `__ for regularized OT [7]. - Entropic regularization OT solver with `Sinkhorn Knopp - Algorithm `__ + Algorithm `__ [2] , stabilized version [9] [10], greedy Sinkhorn [22] and `Screening Sinkhorn - [26] `__ + [26] `__ with optional GPU implementation (requires cupy). - Bregman projections for `Wasserstein - barycenter `__ + barycenter `__ [3], `convolutional - barycenter `__ + barycenter `__ [21] and unmixing [4]. - Sinkhorn divergence [23] and entropic regularization OT from empirical data. - `Smooth optimal transport - solvers `__ + solvers `__ (dual and semi-dual) for KL and squared L2 regularizations [17]. - Non regularized `Wasserstein barycenters - [16] `__) + [16] `__) with LP solver (only small scale). - `Gromov-Wasserstein - distances `__ + distances `__ and `GW - barycenters `__ + barycenters `__ (exact [13] and regularized [12]) - `Fused-Gromov-Wasserstein distances - solver `__ + solver `__ and `FGW - barycenters `__ + barycenters `__ [24] - `Stochastic - solver `__ + solver `__ for Large-scale Optimal Transport (semi-dual problem [18] and dual problem [19]) - Non regularized `free support Wasserstein - barycenters `__ + barycenters `__ [20]. - `Unbalanced - OT `__ + OT `__ with KL relaxation and - `barycenter `__ + `barycenter `__ [10, 25]. - `Partial Wasserstein and - Gromov-Wasserstein `__ + Gromov-Wasserstein `__ (exact [29] and entropic [3] formulations). POT provides the following Machine Learning related solvers: - `Optimal transport for domain - adaptation `__ + adaptation `__ with `group lasso - regularization `__, + regularization `__, `Laplacian - regularization `__ + regularization `__ [5] [30] and `semi supervised - setting `__. + setting `__. - `Linear OT - mapping `__ + mapping `__ [14] and `Joint OT mapping - estimation `__ + estimation `__ [8]. - `Wasserstein Discriminant - Analysis `__ + Analysis `__ [11] (requires autograd + pymanopt). - `JCPOT algorithm for multi-source domain adaptation with target - shift `__ + shift `__ [27]. Some demonstrations are available in the -`documentation `__. +`documentation `__. Using and citing the toolbox ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- cgit v1.2.3