better doc per module

10 files changed, 14 insertions, 41 deletions

diff --git a/ot/__init__.py b/ot/__init__.py
index 1e57b78..2d23610 100644
--- a/ot/__init__.py
+++ b/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`
diff --git a/ot/bregman.py b/ot/bregman.py
index b4365d0..f1f8437 100644
--- a/ot/bregman.py
+++ b/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>
diff --git a/ot/datasets.py b/ot/datasets.py
index daca1ae..bd39e13 100644
--- a/ot/datasets.py
+++ b/ot/datasets.py
@@ -1,5 +1,5 @@
 """
-Simple example datasets for OT
+Simple example datasets 
 """
 
 # Author: Remi Flamary <remi.flamary@unice.fr>
diff --git a/ot/dr.py b/ot/dr.py
index 680dabf..11d2e10 100644
--- a/ot/dr.py
+++ b/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`
 
 """
diff --git a/ot/gpu/__init__.py b/ot/gpu/__init__.py
index 1ab95bb..7478fb9 100644
--- a/ot/gpu/__init__.py
+++ b/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::
diff --git a/ot/gromov.py b/ot/gromov.py
index 43780a4..a678722 100644
--- a/ot/gromov.py
+++ b/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>

diff --git a/ot/optim.py b/ot/optim.py
index 4012e0d..b9ca891 100644
--- a/ot/optim.py
+++ b/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>
diff --git a/ot/partial.py b/ot/partial.py
index c03ec25..eb707d8 100755
--- a/ot/partial.py
+++ b/ot/partial.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Partial OT
+Partial OT solvers
 """
 
 # Author: Laetitia Chapel <laetitia.chapel@irisa.fr>
diff --git a/ot/smooth.py b/ot/smooth.py
index 5a8e4b5..81f6a3e 100644
--- a/ot/smooth.py
+++ b/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.
diff --git a/ot/unbalanced.py b/ot/unbalanced.py
index 23f6607..e37f10c 100644
--- a/ot/unbalanced.py
+++ b/ot/unbalanced.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Regularized Unbalanced OT
+Regularized Unbalanced OT solvers
 """
 
 # Author: Hicham Janati <hicham.janati@inria.fr>