summaryrefslogtreecommitdiff
path: root/docs/source/index.rst
blob: c95e847cdea64a21745bca6a9cd27fc16afe5cbe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.. POT documentation master file, created by
   sphinx-quickstart on Mon Oct 24 11:10:10 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to POT's documentation!
===============================

Contents:

.. toctree::
   :maxdepth: 2

Module list
===========


Module ot
---------

This module provide easy access to solvers for the most common OT problems

.. automodule:: ot
   :members:

Module ot.emd
-------------
.. automodule:: ot.emd
   :members:

Module ot.bregman
-----------------

.. automodule:: ot.bregman
   :members:

Module ot.utils
---------------

.. automodule:: ot.utils
   :members:

Module ot.datasets
------------------

.. automodule:: ot.datasets
   :members:

Module ot.plot
--------------

.. automodule:: ot.plot
   :members:


Examples
========

.. literalinclude:: ../../examples/demo_OT_1D.py

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`