diff options
Diffstat (limited to 'ot/__init__.py')
| -rw-r--r-- | ot/__init__.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/ot/__init__.py b/ot/__init__.py index 3892d1d..89bdc78 100644 --- a/ot/__init__.py +++ b/ot/__init__.py @@ -1,6 +1,16 @@ -"""Python Optimal Transport toolbox +""" + +This is the main module of the POT toolbox. It provides easy access to +a number of functions described below. +.. 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. """ |