summaryrefslogtreecommitdiff
path: root/ot/gpu
diff options
context:
space:
mode:
authorRémi Flamary <remi.flamary@gmail.com>2019-06-06 17:22:05 +0200
committerRémi Flamary <remi.flamary@gmail.com>2019-06-06 17:22:05 +0200
commit1171f7e39742c207dad6ab5fd15f59ed62f8f4a5 (patch)
tree349903e661fa9ae42ed1179221f4b9f585948c7e /ot/gpu
parent0fc6938dc15e8888b0a73fa4b6a421f39f0e0697 (diff)
start documentation ot
Diffstat (limited to 'ot/gpu')
-rw-r--r--ot/gpu/__init__.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/ot/gpu/__init__.py b/ot/gpu/__init__.py
index deda6b1..6a2afcf 100644
--- a/ot/gpu/__init__.py
+++ b/ot/gpu/__init__.py
@@ -5,11 +5,15 @@ This module provides GPU implementation for several OT solvers and utility
functions. The GPU backend in handled by `cupy
<https://cupy.chainer.org/>`_.
+.. warning::
+ Note that by default the module is not import in :mod:`ot`. in order to
+ use it you need to import :mod:`ot.gpu` .
+
By default, the functions in this module accept and return numpy arrays
in order to proide drop-in replacement for the other POT function but
the transfer between CPU en GPU comes with a significant overhead.
-In order to get the best erformances, we recommend to give only cupy
+In order to get the best performances, we recommend to give only cupy
arrays to the functions and desactivate the conversion to numpy of the
result of the function with parameter ``to_numpy=False``.