summaryrefslogtreecommitdiff
path: root/docs/source/all.rst
diff options
context:
space:
mode:
authorCédric Vincent-Cuaz <cedvincentcuaz@gmail.com>2023-03-09 14:21:33 +0100
committerGitHub <noreply@github.com>2023-03-09 14:21:33 +0100
commita5930d3b3a446bf860d6dfacc1e17151fae1dd1d (patch)
tree3897f88fae95c25314be3976f30285bc4db14494 /docs/source/all.rst
parent263a36ff627257422d7e191f6882fb1c8fc68326 (diff)
[MRG] Semi-relaxed (fused) gromov-wasserstein divergence and improvements of gromov-wasserstein solvers (#431)
* maj gw/ srgw/ generic cg solver * correct pep8 on current state * fix bug previous tests * fix pep8 * fix bug srGW constC in loss and gradient * fix doc html * fix doc html * start updating test_optim.py * update tests gromov and optim - plus fix gromov dependencies * add symmetry feature to entropic gw * add symmetry feature to entropic gw * add exemple for sr(F)GW matchings * small stuff * remove (reg,M) from line-search/ complete srgw tests with backend * remove backend repetitions / rename fG to costG/ fix innerlog to True * fix pep8 * take comments into account / new nx parameters still to test * factor (f)gw2 + test new backend parameters in ot.gromov + harmonize stopping criterions * split gromov.py in ot/gromov/ + update test_gromov with helper_backend functions * manual documentaion gromov * remove circular autosummary * trying stuff * debug documentation * alphabetic ordering of module * merge into branch * add note in entropic gw solvers --------- Co-authored-by: Rémi Flamary <remi.flamary@gmail.com>
Diffstat (limited to 'docs/source/all.rst')
-rw-r--r--docs/source/all.rst32
1 files changed, 18 insertions, 14 deletions
diff --git a/docs/source/all.rst b/docs/source/all.rst
index 60cc85c..41d8e06 100644
--- a/docs/source/all.rst
+++ b/docs/source/all.rst
@@ -13,29 +13,33 @@ API and modules
:toctree: gen_modules/
:template: module.rst
- lp
+
backend
bregman
- smooth
- gromov
- optim
da
- dr
- utils
datasets
+ dr
+ factored
+ gaussian
+ gromov
+ lp
+ optim
+ partial
plot
- stochastic
- unbalanced
regpath
- partial
sliced
+ smooth
+ stochastic
+ unbalanced
+ utils
weak
- factored
- gaussian
+
-.. autosummary::
- :toctree: ../modules/generated/
- :template: module.rst
+Main :py:mod:`ot` functions
+--------------
.. automodule:: ot
:members:
+
+
+