Skip to content

[MRG] Update documentation and improve coverage #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rflamary merged 28 commits into from
Apr 28, 2020
Merged

[MRG] Update documentation and improve coverage #160

Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
53265db
build wheels on push to master
rflamary Apr 24, 2020
8599e72
correct doc for emd
rflamary Apr 24, 2020
6931f78
better documentation
rflamary Apr 24, 2020
a5b1b18
add ferradans to da classes documentation
rflamary Apr 24, 2020
bed1680
pep8
rflamary Apr 24, 2020
c529ffd
update doc
rflamary Apr 24, 2020
46523dc
add realeases
rflamary Apr 24, 2020
53b063e
better coverage options verbose and log
rflamary Apr 24, 2020
c3115bc
mockj module cupy for gpu focumentation
rflamary Apr 24, 2020
90bd408
pep8
rflamary Apr 24, 2020
17d388b
test raise un partial ot
rflamary Apr 24, 2020
eb3a70a
left some unused variable...
rflamary Apr 24, 2020
6b42088
better documentation
rflamary Apr 24, 2020
2b43492
test options sphinx gallery
rflamary Apr 24, 2020
0d13d60
Better section name + snhix-gallery tuning
rflamary Apr 24, 2020
99e6d91
Better section name + snhix-gallery tuning
rflamary Apr 24, 2020
fe704c3
test autosummary
rflamary Apr 24, 2020
1a3249d
awesome mini gallery
rflamary Apr 24, 2020
b9ad0ee
add template
rflamary Apr 24, 2020
ad7aa89
better doc per module
rflamary Apr 24, 2020
08ec66e
pep8
rflamary Apr 24, 2020
576c3d5
better thumbnail image for gallery
rflamary Apr 24, 2020
e18e18f
test new foldeer
rflamary Apr 24, 2020
a547751
exmaples in sections
rflamary Apr 24, 2020
4bbabc6
relative path exmaples
rflamary Apr 24, 2020
956df7a
vchange path in examples
rflamary Apr 24, 2020
71e7984
update proper links form readme
rflamary Apr 24, 2020
3b0732b
correct url for examples
rflamary Apr 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update doc
  • Loading branch information
@rflamary
rflamary committed Apr 24, 2020
commit c529ffdfa02e9f81d52d46737c9568129fe449b3
18 changes: 9 additions & 9 deletions docs/source/readme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
POT: Python Optimal Transport
=============================

|PyPI version| |Anaconda Cloud| |Build Status| |Build Status| |Codecov
Status| |Downloads| |Anaconda downloads| |License|
|PyPI version| |Anaconda Cloud| |Build Status| |Codecov Status|
|Downloads| |Anaconda downloads| |License|

This open source Python library provide several solvers for optimization
problems related to Optimal Transport for signal, image processing and
Expand Down Expand Up @@ -96,11 +96,12 @@ Using and citing the toolbox
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you use this toolbox in your research and find it useful, please cite
POT using the following bibtex reference:
POT using the following reference:

::

Rémi Flamary and Nicolas Courty, POT Python Optimal Transport library, Website: https://pythonot.github.io/, 2017
Rémi Flamary and Nicolas Courty, POT Python Optimal Transport library,
Website: https://pythonot.github.io/, 2017

In Bibtex format:

Expand Down Expand Up @@ -141,11 +142,11 @@ You can install the toolbox through PyPI with:

pip install POT

or get the very latest version by downloading it and then running:
or get the very latest version by running:

::

python setup.py install --user # for user install (no root)
pip install -U https://github.com/PythonOT/POT/archive/master.zip # with --user for user install (no root)

Anaconda installation with conda-forge
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -245,7 +246,8 @@ This toolbox has been created and is maintained by

The contributors to this library are

- `Alexandre Gramfort <http://alexandre.gramfort.net/>`__ (CI)
- `Alexandre Gramfort <http://alexandre.gramfort.net/>`__ (CI,
documentation)
- `Laetitia Chapel <http://people.irisa.fr/Laetitia.Chapel/>`__
(Partial OT)
- `Michael Perrot <http://perso.univ-st-etienne.fr/pem82055/>`__
Expand Down Expand Up @@ -452,8 +454,6 @@ NIPS Workshop on Optimal Transport and Machine Learning OTML, 2014.
:target: https://badge.fury.io/py/POT
.. |Anaconda Cloud| image:: https://anaconda.org/conda-forge/pot/badges/version.svg
:target: https://anaconda.org/conda-forge/pot
.. |Build Status| image:: https://travis-ci.org/PythonOT/POT.svg?branch=master
:target: https://travis-ci.org/PythonOT/POT
.. |Build Status| image:: https://github.com/PythonOT/POT/workflows/build/badge.svg
:target: https://github.com/PythonOT/POT/actions
.. |Codecov Status| image:: https://codecov.io/gh/PythonOT/POT/branch/master/graph/badge.svg
Expand Down