diff options
| author | Rémi Flamary <remi.flamary@gmail.com> | 2019-06-06 17:22:05 +0200 |
|---|---|---|
| committer | Rémi Flamary <remi.flamary@gmail.com> | 2019-06-06 17:22:05 +0200 |
| commit | 1171f7e39742c207dad6ab5fd15f59ed62f8f4a5 (patch) | |
| tree | 349903e661fa9ae42ed1179221f4b9f585948c7e /ot/__init__.py | |
| parent | 0fc6938dc15e8888b0a73fa4b6a421f39f0e0697 (diff) | |
start documentation ot
Diffstat (limited to 'ot/__init__.py')
| -rw-r--r-- | ot/__init__.py | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/ot/__init__.py b/ot/__init__.py index b74b924..6d6dc75 100644 --- a/ot/__init__.py +++ b/ot/__init__.py @@ -1,6 +1,20 @@ -"""Python Optimal Transport toolbox +""" + +This is the main module of the POT toolbox. It provides easy access to +a number of functions described below. + +### FAQ + +#### How to compute the Wasserstein distance ? +.. warning:: + 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` + The other sub-modules are not imported due to additional dependencies. """ |