summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRémi Flamary <remi.flamary@gmail.com>2020-04-24 14:56:25 +0200
committerRémi Flamary <remi.flamary@gmail.com>2020-04-24 14:56:25 +0200
commit6b42088a1e089d488b1e2f4f2b42084255f331cf (patch)
tree7bd1743651cefb91284a520f5493f9422fb951d6 /docs
parenteb3a70af671736c940c8aceaff8547b057d1335a (diff)
better documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/source/all.rst4
-rw-r--r--docs/source/conf.py6
-rw-r--r--docs/source/releases.rst20
3 files changed, 15 insertions, 15 deletions
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 <all.html#ot.bregman.empirical_sinkhorn_divergence>`__
corresponding `Wasserstein
1D <all.html#ot.lp.wasserstein_1d>`__.
We now also have implementations for `Unbalanced
-OT <auto_examples/plot_UOT_1D.html/>`__
+OT <auto_examples/plot_UOT_1D.html>`__
and a solver for `Unbalanced OT
-barycenters <auto_examples/plot_UOT_barycenter_1D.html/>`__.
+barycenters <auto_examples/plot_UOT_barycenter_1D.html>`__.
A new variant of Gromov-Wasserstein divergence called `Fused
Gromov-Wasserstein <all.html?highlight=fused_#ot.gromov.fused_gromov_wasserstein>`__
has been also contributed with exemples of use on `structured
-data <auto_examples/plot_fgw.html/>`__
+data <auto_examples/plot_fgw.html>`__
and computing `barycenters of labeld
-graphs <auto_examples/plot_barycenter_fgw.html/>`__.
+graphs <auto_examples/plot_barycenter_fgw.html>`__.
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 <auto_examples/plot_gromov.html/>`__,
+ solver <auto_examples/plot_gromov.html>`__,
a new `greedy variant of
sinkhorn <all.html#ot.bregman.greenkhorn>`__,
| `non-regularized <all.html#ot.lp.barycenter>`__,
`convolutional
- (2D) <auto_examples/plot_convolutional_barycenter.html/>`__
+ (2D) <auto_examples/plot_convolutional_barycenter.html>`__
and `free
- support <auto_examples/plot_free_support_barycenter.html/>`__
+ support <auto_examples/plot_free_support_barycenter.html>`__
Wasserstein barycenters and
- `smooth <https://github.com/rflamary/POT/blob/prV0.5/notebooks/plot_OT_1D_smooth.html/>`__
+ `smooth <https://github.com/rflamary/POT/blob/prV0.5/notebooks/plot_OT_1D_smooth.html>`__
and
`stochastic <all.html#ot.stochastic.sgd_entropic_regularization>`__
implementation of entropic OT.