better doc per module

Author: rflamary

ot/__init__.py

@@ -1,35 +1,5 @@
 """
 
-This is the main module of the POT toolbox. It provides easy access to
-a number of sub-modules and functions described below.
-
-.. note::
-
-
-    Here is a list of the submodules and short description of what they contain.
-
-    - :any:`ot.lp` contains OT solvers for the exact (Linear Program) OT problems.
-    - :any:`ot.bregman` contains OT solvers for the entropic OT problems using
-      Bregman projections.
-    - :any:`ot.lp` contains OT solvers for the exact (Linear Program) OT problems.
-    - :any:`ot.smooth` contains OT solvers for the regularized (l2 and kl) smooth OT
-      problems.
-    - :any:`ot.gromov` contains solvers for Gromov-Wasserstein and Fused Gromov
-      Wasserstein problems.
-    - :any:`ot.optim` contains generic solvers OT based optimization problems
-    - :any:`ot.da` contains classes and function related to Monge mapping
-      estimation and Domain Adaptation (DA).
-    - :any:`ot.gpu` contains GPU (cupy) implementation of some OT solvers
-    - :any:`ot.dr` contains Dimension Reduction (DR) methods such as Wasserstein
-      Discriminant Analysis.
-    - :any:`ot.utils` contains utility functions such as distance computation and
-      timing.
-    - :any:`ot.datasets` contains toy dataset generation functions.
-    - :any:`ot.plot` contains visualization functions
-    - :any:`ot.stochastic` contains stochastic solvers for regularized OT.
-    - :any:`ot.unbalanced` contains solvers for regularized unbalanced OT.
-    - :any:`ot.partial` contains solvers for partial OT.
-
 .. warning::
     The list of automatically imported sub-modules is as follows:
     :py:mod:`ot.lp`, :py:mod:`ot.bregman`, :py:mod:`ot.optim`

ot/bregman.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Bregman projections for regularized OT
+Bregman projections solvers for entropic regularized OT
 """
 
 # Author: Remi Flamary <remi.flamary@unice.fr>

ot/datasets.py

@@ -1,5 +1,5 @@
 """
-Simple example datasets for OT
+Simple example datasets 
 """
 
 # Author: Remi Flamary <remi.flamary@unice.fr>

ot/dr.py

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 """
-Dimension reduction with optimal transport
+Dimension reduction with OT
 
 
 .. warning::
-    Note that by default the module is not import in :mod:`ot`. In order to
+    Note that by default the module is not imported in :mod:`ot`. In order to
     use it you need to explicitely import :mod:`ot.dr`
 
 """

ot/gpu/__init__.py

@@ -1,8 +1,9 @@
 # -*- coding: utf-8 -*-
 """
+GPU implementation for several OT solvers and utility 
+functions. 
 
-This module provides GPU implementation for several OT solvers and utility 
-functions. The GPU backend in handled by `cupy 
+The GPU backend in handled by `cupy 
 <https://cupy.chainer.org/>`_.
 
 .. warning::

ot/gromov.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Gromov-Wasserstein transport method
+Gromov-Wasserstein and Fused-Gromov-Wasserstein solvers 
 """
 
 # Author: Erwan Vautier <erwan.vautier@gmail.com>

ot/optim.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Optimization algorithms for OT
+Generic solvers for regularized OT
 """
 
 # Author: Remi Flamary <remi.flamary@unice.fr>

ot/partial.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Partial OT
+Partial OT solvers
 """
 
 # Author: Laetitia Chapel <laetitia.chapel@irisa.fr>

ot/smooth.py

@@ -26,7 +26,9 @@
 #         Remi Flamary <remi.flamary@unice.fr>
 
 """
-Implementation of
+Smooth and Sparse Optimal Transport solvers (KL an L2 reg.)
+
+Implementation of :
 Smooth and Sparse Optimal Transport.
 Mathieu Blondel, Vivien Seguy, Antoine Rolet.
 In Proc. of AISTATS 2018.

ot/unbalanced.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Regularized Unbalanced OT
+Regularized Unbalanced OT solvers
 """
 
 # Author: Hicham Janati <hicham.janati@inria.fr>