diff options
| author | Rémi Flamary <remi.flamary@gmail.com> | 2020-04-28 09:50:45 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-28 09:50:45 +0200 |
| commit | afedeebf5bdd58ff92f52c73b9b41b8a8e66ca29 (patch) | |
| tree | 60fafb54d66aa843965c000d48d249780afdcf75 /docs/source/all.rst | |
| parent | b53fb23b538e0b7f6498bc217f02adac3c8f7d07 (diff) | |
| parent | 3b0732b041d46df66cb182b17f6ece040c578722 (diff) | |
Merge pull request #160 from PythonOT/doc_cov
[MRG] Update documentation and improve coverage
Diffstat (limited to 'docs/source/all.rst')
| -rw-r--r-- | docs/source/all.rst | 110 |
1 files changed, 26 insertions, 84 deletions
diff --git a/docs/source/all.rst b/docs/source/all.rst index a6d9790..d7b878f 100644 --- a/docs/source/all.rst +++ b/docs/source/all.rst @@ -1,94 +1,36 @@ +.. _sphx_glr_api_reference: -Python modules -============== +API and modules +=============== -ot --- +.. currentmodule:: ot -.. automodule:: ot - :members: - -ot.lp ------ -.. automodule:: ot.lp - :members: - -ot.bregman ----------- - -.. automodule:: ot.bregman - :members: - -ot.smooth ------ -.. automodule:: ot.smooth - :members: - -ot.gromov ----------- - -.. automodule:: ot.gromov - :members: - - -ot.optim --------- - -.. automodule:: ot.optim - :members: - -ot.da --------- -.. automodule:: ot.da - :members: +:py:mod:`ot`: -ot.gpu --------- +.. autosummary:: + :toctree: gen_modules/ + :template: module.rst -.. automodule:: ot.gpu - :members: + lp + bregman + smooth + gromov + optim + da + gpu + dr + utils + datasets + plot + stochastic + unbalanced + partial -ot.dr --------- +.. autosummary:: + :toctree: ../modules/generated/ + :template: module.rst -.. automodule:: ot.dr - :members: - - -ot.utils --------- - -.. automodule:: ot.utils - :members: - -ot.datasets ------------ - -.. automodule:: ot.datasets - :members: - -ot.plot -------- - -.. automodule:: ot.plot - :members: - -ot.stochastic -------------- - -.. automodule:: ot.stochastic +.. automodule:: ot :members: - -ot.unbalanced -------------- - -.. automodule:: ot.unbalanced - :members: - -ot.partial -------------- - -.. automodule:: ot.partial - :members: |