From 9f63ee92e281427ab3d520f75bb9c3406b547365 Mon Sep 17 00:00:00 2001 From: Laetitia Chapel Date: Thu, 9 Apr 2020 13:55:27 +0200 Subject: initial commit partial Wass and GW --- docs/source/all.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/source/all.rst') diff --git a/docs/source/all.rst b/docs/source/all.rst index c968aa1..a6d9790 100644 --- a/docs/source/all.rst +++ b/docs/source/all.rst @@ -86,3 +86,9 @@ ot.unbalanced .. automodule:: ot.unbalanced :members: + +ot.partial +------------- + +.. automodule:: ot.partial + :members: -- cgit v1.2.3 From 6b42088a1e089d488b1e2f4f2b42084255f331cf Mon Sep 17 00:00:00 2001 From: Rémi Flamary Date: Fri, 24 Apr 2020 14:56:25 +0200 Subject: better documentation --- Makefile | 4 +++- docs/source/all.rst | 4 ++-- docs/source/conf.py | 6 +++--- docs/source/releases.rst | 20 ++++++++++---------- 4 files changed, 18 insertions(+), 16 deletions(-) (limited to 'docs/source/all.rst') diff --git a/Makefile b/Makefile index 202b209..70cdbdd 100644 --- a/Makefile +++ b/Makefile @@ -62,7 +62,9 @@ rdoc : pandoc --from=markdown --to=rst --output=docs/source/releases.rst RELEASES.md sed -i 's,https://pot.readthedocs.io/en/latest/,,g' docs/source/releases.rst sed -i 's,https://github.com/rflamary/POT/blob/master/notebooks/,auto_examples/,g' docs/source/releases.rst - sed -i 's,.ipynb,.html/,g' docs/source/releases.rst + sed -i 's,.ipynb,.html,g' docs/source/releases.rst + sed -i 's,https://pythonot.github.io/auto_examples/,auto_examples/,g' docs/source/releases.rst + notebook : ipython notebook --matplotlib=inline --notebook-dir=notebooks/ diff --git a/docs/source/all.rst b/docs/source/all.rst index a6d9790..f4ba559 100644 --- a/docs/source/all.rst +++ b/docs/source/all.rst @@ -1,7 +1,7 @@ -Python modules -============== +API and modules +=============== ot -- diff --git a/docs/source/conf.py b/docs/source/conf.py index 3699156..101ccd9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -88,7 +88,7 @@ master_doc = 'index' # General information about the project. project = u'POT Python Optimal Transport' -copyright = u'2016-2019, Rémi Flamary, Nicolas Courty' +copyright = u'2016-2020, Rémi Flamary, Nicolas Courty' author = u'Rémi Flamary, Nicolas Courty' # The version info for the project you're documenting, acts as replacement for @@ -297,7 +297,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'pot', u'POT Python Optimal Transport library Documentation', + (master_doc, 'pot', u'POT Python Optimal Transport', [author], 1) ] @@ -312,7 +312,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'POT', u'POT Python Optimal Transport library Documentation', - author, 'POT', 'Python Optimal Transport librar.', + author, 'POT', 'Python Optimal Transport library', 'Miscellaneous'), ] diff --git a/docs/source/releases.rst b/docs/source/releases.rst index 58bfcfb..6b64066 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -1,5 +1,5 @@ -POT Releases -============ +Releases +======== 0.6 Year 3 ---------- @@ -28,15 +28,15 @@ divergence `__ corresponding `Wasserstein 1D `__. We now also have implementations for `Unbalanced -OT `__ +OT `__ and a solver for `Unbalanced OT -barycenters `__. +barycenters `__. A new variant of Gromov-Wasserstein divergence called `Fused Gromov-Wasserstein `__ has been also contributed with exemples of use on `structured -data `__ +data `__ and computing `barycenters of labeld -graphs `__. +graphs `__. A lot of work has been done on the documentation with several new examples corresponding to the new features and a lot of corrections for @@ -88,16 +88,16 @@ toolbox as listed below but also several bug correction. | Among the new features, we can highlight a `non-regularized Gromov-Wasserstein - solver `__, + solver `__, a new `greedy variant of sinkhorn `__, | `non-regularized `__, `convolutional - (2D) `__ + (2D) `__ and `free - support `__ + support `__ Wasserstein barycenters and - `smooth `__ + `smooth `__ and `stochastic `__ implementation of entropic OT. -- cgit v1.2.3 From fe704c348e2f1fc69c0ecd801e8fefd6888a215d Mon Sep 17 00:00:00 2001 From: Rémi Flamary Date: Fri, 24 Apr 2020 15:51:20 +0200 Subject: test autosummary --- docs/source/all.rst | 5 +++++ docs/source/conf.py | 1 + 2 files changed, 6 insertions(+) (limited to 'docs/source/all.rst') diff --git a/docs/source/all.rst b/docs/source/all.rst index f4ba559..fb6f218 100644 --- a/docs/source/all.rst +++ b/docs/source/all.rst @@ -1,4 +1,5 @@ +.. _sphx_glr_api_reference: API and modules =============== @@ -92,3 +93,7 @@ ot.partial .. automodule:: ot.partial :members: + +.. autosummary:: + :toctree: gen_modules/ + :template: module.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 546eb5d..c693a02 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,6 +59,7 @@ sys.path.insert(0, os.path.abspath("../..")) # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', -- cgit v1.2.3 From 1a3249dd6d6971de23534b797ce81fd670befa2b Mon Sep 17 00:00:00 2001 From: Rémi Flamary Date: Fri, 24 Apr 2020 16:20:37 +0200 Subject: awesome mini gallery --- docs/source/all.rst | 111 ++++++++++++---------------------------------------- docs/source/conf.py | 3 ++ 2 files changed, 27 insertions(+), 87 deletions(-) (limited to 'docs/source/all.rst') diff --git a/docs/source/all.rst b/docs/source/all.rst index fb6f218..d7b878f 100644 --- a/docs/source/all.rst +++ b/docs/source/all.rst @@ -4,96 +4,33 @@ 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: - -ot.gpu --------- - -.. automodule:: ot.gpu - :members: -ot.dr --------- +:py:mod:`ot`: -.. automodule:: ot.dr - :members: - - -ot.utils --------- - -.. automodule:: ot.utils - :members: - -ot.datasets ------------ - -.. automodule:: ot.datasets - :members: - -ot.plot -------- - -.. automodule:: ot.plot - :members: +.. autosummary:: + :toctree: gen_modules/ + :template: module.rst + + lp + bregman + smooth + gromov + optim + da + gpu + dr + utils + datasets + plot + stochastic + unbalanced + partial -ot.stochastic -------------- +.. autosummary:: + :toctree: ../modules/generated/ + :template: module.rst -.. automodule:: ot.stochastic +.. automodule:: ot :members: - -ot.unbalanced -------------- - -.. automodule:: ot.unbalanced - :members: - -ot.partial -------------- - -.. automodule:: ot.partial - :members: - -.. autosummary:: - :toctree: gen_modules/ - :template: module.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index c693a02..1a64d93 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -71,6 +71,9 @@ extensions = [ 'sphinx_gallery.gen_gallery', ] +autosummary_generate = True + + napoleon_numpy_docstring = True # Add any paths that contain templates here, relative to this directory. -- cgit v1.2.3