|
1 | 1 | """
|
2 | 2 |
|
3 |
| -This is the main module of the POT toolbox. It provides easy access to |
4 |
| -a number of sub-modules and functions described below. |
| 3 | +This is the main module of the POT toolbox. It provides easy access to |
| 4 | +a number of sub-modules and functions described below. |
5 | 5 |
|
6 | 6 | .. note::
|
7 | 7 |
|
|
14 | 14 | - :any:`ot.lp` contains OT solvers for the exact (Linear Program) OT problems.
|
15 | 15 | - :any:`ot.smooth` contains OT solvers for the regularized (l2 and kl) smooth OT
|
16 | 16 | problems.
|
17 |
| - - :any:`ot.gromov` contains solvers for Gromov-Wasserstein and Fused Gromov |
| 17 | + - :any:`ot.gromov` contains solvers for Gromov-Wasserstein and Fused Gromov |
18 | 18 | Wasserstein problems.
|
19 |
| - - :any:`ot.optim` contains generic solvers OT based optimization problems |
| 19 | + - :any:`ot.optim` contains generic solvers OT based optimization problems |
20 | 20 | - :any:`ot.da` contains classes and function related to Monge mapping
|
21 | 21 | estimation and Domain Adaptation (DA).
|
22 | 22 | - :any:`ot.gpu` contains GPU (cupy) implementation of some OT solvers
|
23 |
| - - :any:`ot.dr` contains Dimension Reduction (DR) methods such as Wasserstein |
| 23 | + - :any:`ot.dr` contains Dimension Reduction (DR) methods such as Wasserstein |
24 | 24 | Discriminant Analysis.
|
25 |
| - - :any:`ot.utils` contains utility functions such as distance computation and |
26 |
| - timing. |
| 25 | + - :any:`ot.utils` contains utility functions such as distance computation and |
| 26 | + timing. |
27 | 27 | - :any:`ot.datasets` contains toy dataset generation functions.
|
28 | 28 | - :any:`ot.plot` contains visualization functions
|
29 | 29 | - :any:`ot.stochastic` contains stochastic solvers for regularized OT.
|
30 | 30 | - :any:`ot.unbalanced` contains solvers for regularized unbalanced OT.
|
31 | 31 |
|
32 | 32 | .. warning::
|
33 |
| - The list of automatically imported sub-modules is as follows: |
| 33 | + The list of automatically imported sub-modules is as follows: |
34 | 34 | :py:mod:`ot.lp`, :py:mod:`ot.bregman`, :py:mod:`ot.optim`
|
35 | 35 | :py:mod:`ot.utils`, :py:mod:`ot.datasets`,
|
36 | 36 | :py:mod:`ot.gromov`, :py:mod:`ot.smooth`
|
37 |
| - :py:mod:`ot.stochastic` |
| 37 | + :py:mod:`ot.stochastic` |
38 | 38 |
|
39 | 39 | The following sub-modules are not imported due to additional dependencies:
|
40 | 40 |
|
|
65 | 65 | # OT functions
|
66 | 66 | from .lp import emd, emd2, emd_1d, emd2_1d, wasserstein_1d
|
67 | 67 | from .bregman import sinkhorn, sinkhorn2, barycenter
|
68 |
| -from .unbalanced import sinkhorn_unbalanced, barycenter_unbalanced |
| 68 | +from .unbalanced import sinkhorn_unbalanced, barycenter_unbalanced, sinkhorn_unbalanced2 |
69 | 69 | from .da import sinkhorn_lpl1_mm
|
70 | 70 |
|
71 | 71 | # utils functions
|
72 | 72 | from .utils import dist, unif, tic, toc, toq
|
73 | 73 |
|
74 |
| -__version__ = "1.0.0" |
| 74 | +__version__ = "0.6.0" |
75 | 75 |
|
76 |
| -__all__ = ["emd", "emd2", 'emd_1d','emd2_1d', 'wasserstein_1d', |
77 |
| - "sinkhorn", "sinkhorn2", 'barycenter', |
78 |
| - 'sinkhorn_lpl1_mm', |
79 |
| - 'sinkhorn_unbalanced', "barycenter_unbalanced", |
80 |
| - 'dist', 'unif', 'tic', 'toc', 'toq', |
81 |
| - "utils", 'datasets', 'bregman', 'lp', 'gromov', 'da', 'optim'] |
| 76 | +__all__ = ['emd', 'emd2', 'emd_1d', 'sinkhorn', 'sinkhorn2', 'utils', 'datasets', |
| 77 | + 'bregman', 'lp', 'tic', 'toc', 'toq', 'gromov', |
| 78 | + 'emd_1d', 'emd2_1d', 'wasserstein_1d', |
| 79 | + 'dist', 'unif', 'barycenter', 'sinkhorn_lpl1_mm', 'da', 'optim', |
| 80 | + 'sinkhorn_unbalanced', 'barycenter_unbalanced', |
| 81 | + 'sinkhorn_unbalanced2'] |
0 commit comments