diff options
| author | Rémi Flamary <remi.flamary@gmail.com> | 2019-07-03 14:34:13 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-07-03 14:34:13 +0200 |
| commit | 952503e02b1fc9bdf0811b937baacca57e4a98f1 (patch) | |
| tree | c5b1b8f10eaee4c2ecaa12f629255489c2481590 /ot/gpu/__init__.py | |
| parent | 8b3927bb5e8935c3dbddf054f054dc0c036fbdfe (diff) | |
| parent | 7402d344240ce94e33c53daff419d4356278d48f (diff) | |
Merge pull request #88 from rflamary/doc_modules
[MRG] Update documentation and add quick start guide
Diffstat (limited to 'ot/gpu/__init__.py')
| -rw-r--r-- | ot/gpu/__init__.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/ot/gpu/__init__.py b/ot/gpu/__init__.py index deda6b1..1ab95bb 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 explicitely 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``. |