Merge pull request #154 from PythonOT/doc

[WIP] Cleanup documentation and examples

Author: rflamary

.github/workflows/main.yml

@@ -1,3 +1,4 @@
+name: circleci-redirector
 on: [status]
 jobs:
   circleci_artifacts_redirector_job:

.github/workflows/pythonpackage.yml

@@ -36,7 +36,7 @@ jobs:
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics        
+        flake8 examples/ ot/ test/ --count --max-line-length=127 --statistics        
     - name: Install POT
       run: |
         pip install -e .

codecov.yml

@@ -12,3 +12,5 @@ coverage:
 comment:
   layout: "header, diff, sunburst, uncovered"
   behavior: default
+codecov:
+  token: 057953e4-d263-41c0-913c-5d45c0371df9

docs/rtd/index.md

@@ -1 +1,5 @@
-<meta http-equiv="refresh" content="0; URL=https://PythonOT.github.io">`
+<meta http-equiv="refresh" content="0; URL=https://PythonOT.github.io">
+
+# POT: Python Optimal Transport
+
+The documentation has been moved to : [https://PythonOT.github.io](https://PythonOT.github.io)

examples/plot_gromov_barycenter.py

@@ -89,10 +89,10 @@ def im2mat(I):
     return I.reshape((I.shape[0] * I.shape[1], I.shape[2]))
 
 
-square = pl.imread('../data/square.png').astype(np.float64)[:, :, 2] / 256
-cross = pl.imread('../data/cross.png').astype(np.float64)[:, :, 2] / 256
-triangle = pl.imread('../data/triangle.png').astype(np.float64)[:, :, 2] / 256
-star = pl.imread('../data/star.png').astype(np.float64)[:, :, 2] / 256
+square = pl.imread('../data/square.png').astype(np.float64)[:, :, 2]
+cross = pl.imread('../data/cross.png').astype(np.float64)[:, :, 2]
+triangle = pl.imread('../data/triangle.png').astype(np.float64)[:, :, 2]
+star = pl.imread('../data/star.png').astype(np.float64)[:, :, 2]
 
 shapes = [square, cross, triangle, star]
 

examples/plot_otda_mapping_colors_images.py

@@ -8,11 +8,9 @@
 estimation [8].
 
 [6] Ferradans, S., Papadakis, N., Peyre, G., & Aujol, J. F. (2014). Regularized
-    discrete optimal transport. SIAM Journal on Imaging Sciences, 7(3),
-    1853-1882.
+discrete optimal transport. SIAM Journal on Imaging Sciences, 7(3), 1853-1882.
 [8] M. Perrot, N. Courty, R. Flamary, A. Habrard, "Mapping estimation for
-    discrete optimal transport", Neural Information Processing Systems (NIPS),
-    2016.
+discrete optimal transport", Neural Information Processing Systems (NIPS), 2016.
 
 """