summaryrefslogtreecommitdiff
path: root/ot/__init__.py
diff options
context:
space:
mode:
authorRĂ©mi Flamary <remi.flamary@gmail.com>2020-04-28 09:50:45 +0200
committerGitHub <noreply@github.com>2020-04-28 09:50:45 +0200
commitafedeebf5bdd58ff92f52c73b9b41b8a8e66ca29 (patch)
tree60fafb54d66aa843965c000d48d249780afdcf75 /ot/__init__.py
parentb53fb23b538e0b7f6498bc217f02adac3c8f7d07 (diff)
parent3b0732b041d46df66cb182b17f6ece040c578722 (diff)
Merge pull request #160 from PythonOT/doc_cov
[MRG] Update documentation and improve coverage
Diffstat (limited to 'ot/__init__.py')
-rw-r--r--ot/__init__.py30
1 files changed, 0 insertions, 30 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`