summaryrefslogtreecommitdiff
path: root/ot/dr.py
diff options
context:
space:
mode:
authorRĂ©mi Flamary <remi.flamary@gmail.com>2019-07-03 14:34:13 +0200
committerGitHub <noreply@github.com>2019-07-03 14:34:13 +0200
commit952503e02b1fc9bdf0811b937baacca57e4a98f1 (patch)
treec5b1b8f10eaee4c2ecaa12f629255489c2481590 /ot/dr.py
parent8b3927bb5e8935c3dbddf054f054dc0c036fbdfe (diff)
parent7402d344240ce94e33c53daff419d4356278d48f (diff)
Merge pull request #88 from rflamary/doc_modules
[MRG] Update documentation and add quick start guide
Diffstat (limited to 'ot/dr.py')
-rw-r--r--ot/dr.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/ot/dr.py b/ot/dr.py
index d30ab30..d2bf6e2 100644
--- a/ot/dr.py
+++ b/ot/dr.py
@@ -1,6 +1,12 @@
# -*- coding: utf-8 -*-
"""
Dimension reduction with optimal transport
+
+
+.. warning::
+ Note that by default the module is not import in :mod:`ot`. In order to
+ use it you need to explicitely import :mod:`ot.dr`
+
"""
# Author: Remi Flamary <remi.flamary@unice.fr>