Merge pull request #99 from hichamjanati/unbalanced-bar

[MRG] Add stabilization for unbalanced OT and barycenter computation

Author: rflamary

.gitignore

@@ -59,6 +59,9 @@ coverage.xml
 *.mo
 *.pot
 
+# xml
+*.xml
+
 # Django stuff:
 *.log
 local_settings.py

docs/source/quickstart.rst

@@ -1,7 +1,7 @@
 """
 
-This is the main module of the POT toolbox. It provides easy access to 
-a number of sub-modules and functions described below. 
+This is the main module of the POT toolbox. It provides easy access to
+a number of sub-modules and functions described below.
 
 .. note::
 
@@ -14,27 +14,27 @@
     - :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 
+    - :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.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 
+    - :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.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.
 
 .. warning::
-    The list of automatically imported sub-modules is as follows: 
+    The list of automatically imported sub-modules is as follows:
     :py:mod:`ot.lp`, :py:mod:`ot.bregman`, :py:mod:`ot.optim`
     :py:mod:`ot.utils`, :py:mod:`ot.datasets`,
     :py:mod:`ot.gromov`, :py:mod:`ot.smooth`
-    :py:mod:`ot.stochastic`    
+    :py:mod:`ot.stochastic`
 
     The following sub-modules are not imported due to additional dependencies:
 
@@ -65,7 +65,7 @@
 # OT functions
 from .lp import emd, emd2, emd_1d, emd2_1d, wasserstein_1d
 from .bregman import sinkhorn, sinkhorn2, barycenter
-from .unbalanced import sinkhorn_unbalanced, barycenter_unbalanced
+from .unbalanced import sinkhorn_unbalanced, barycenter_unbalanced, sinkhorn_unbalanced2
 from .da import sinkhorn_lpl1_mm
 
 # utils functions
@@ -77,4 +77,5 @@
            'bregman', 'lp', 'tic', 'toc', 'toq', 'gromov',
            'emd_1d', 'emd2_1d', 'wasserstein_1d',
            'dist', 'unif', 'barycenter', 'sinkhorn_lpl1_mm', 'da', 'optim',
-           'sinkhorn_unbalanced', "barycenter_unbalanced"]
+           'sinkhorn_unbalanced', 'barycenter_unbalanced',
+           'sinkhorn_unbalanced2']