Skip to content

Commit ad02112

Browse files
authored
[MRG] Update examples in the doc (#359)
* add transparent color logo * add transparent color logo * move screenkhorn * move stochastic and install ffmpeg on circleci * try something * add sudo * install ffmpeg before python * cleanup examples * test svg scrapper * add animation for reg path * better example OT sivergence * update ttles and add plots * update free support * proper figure indexes * have less frame sin animation * update readme and release file * add tests for python 3.10
1 parent 0afd84d commit ad02112

23 files changed

+371
-191
lines changed

.circleci/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ jobs:
3535
- data-cache-0
3636
- pip-cache
3737

38+
- run:
39+
name: Install ffmpeg
40+
command: |
41+
sudo apt update
42+
sudo apt install ffmpeg
43+
3844
- run:
3945
name: Get Python running
4046
command: |
@@ -50,6 +56,7 @@ jobs:
5056
paths:
5157
- ~/.cache/pip
5258

59+
5360
# Look at what we have and fail early if there is some library conflict
5461
- run:
5562
name: Check installation

.github/workflows/build_tests.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
strategy:
2323
max-parallel: 4
2424
matrix:
25-
python-version: ["3.7", "3.8", "3.9"]
25+
python-version: ["3.7", "3.8", "3.9", "3.10"]
2626

2727
steps:
2828
- uses: actions/checkout@v1
@@ -93,7 +93,7 @@ jobs:
9393
strategy:
9494
max-parallel: 4
9595
matrix:
96-
python-version: ["3.7", "3.8", "3.9"]
96+
python-version: ["3.7", "3.8", "3.9", "3.10"]
9797

9898
steps:
9999
- uses: actions/checkout@v1
@@ -120,7 +120,7 @@ jobs:
120120
strategy:
121121
max-parallel: 4
122122
matrix:
123-
python-version: ["3.7", "3.8", "3.9"]
123+
python-version: ["3.7", "3.8", "3.9", "3.10"]
124124

125125
steps:
126126
- uses: actions/checkout@v1

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,11 @@ POT provides the following generic OT solvers (links to examples):
2929
* Non regularized [Wasserstein barycenters [16] ](https://pythonot.github.io/auto_examples/barycenters/plot_barycenter_lp_vs_entropic.html)) with LP solver (only small scale).
3030
* [Gromov-Wasserstein distances](https://pythonot.github.io/auto_examples/gromov/plot_gromov.html) and [GW barycenters](https://pythonot.github.io/auto_examples/gromov/plot_gromov_barycenter.html) (exact [13] and regularized [12]), differentiable using gradients from
3131
* [Fused-Gromov-Wasserstein distances solver](https://pythonot.github.io/auto_examples/gromov/plot_fgw.html#sphx-glr-auto-examples-plot-fgw-py) and [FGW barycenters](https://pythonot.github.io/auto_examples/gromov/plot_barycenter_fgw.html) [24]
32-
* [Stochastic solver](https://pythonot.github.io/auto_examples/plot_stochastic.html) for Large-scale Optimal Transport (semi-dual problem [18] and dual problem [19])
33-
* [Stochastic solver of Gromov Wasserstein](https://pythonot.github.io/auto_examples/gromov/plot_gromov.html) for large-scale problem with any loss functions [33]
32+
* [Stochastic
33+
solver](https://pythonot.github.io/auto_examples/others/plot_stochastic.html) and
34+
[differentiable losses](https://pythonot.github.io/auto_examples/backends/plot_stoch_continuous_ot_pytorch.html) for
35+
Large-scale Optimal Transport (semi-dual problem [18] and dual problem [19])
36+
* [Sampled solver of Gromov Wasserstein](https://pythonot.github.io/auto_examples/gromov/plot_gromov.html) for large-scale problem with any loss functions [33]
3437
* Non regularized [free support Wasserstein barycenters](https://pythonot.github.io/auto_examples/barycenters/plot_free_support_barycenter.html) [20].
3538
* [Unbalanced OT](https://pythonot.github.io/auto_examples/unbalanced-partial/plot_UOT_1D.html) with KL relaxation and [barycenter](https://pythonot.github.io/auto_examples/unbalanced-partial/plot_UOT_barycenter_1D.html) [10, 25].
3639
* [Partial Wasserstein and Gromov-Wasserstein](https://pythonot.github.io/auto_examples/unbalanced-partial/plot_partial_wass_and_gromov.html) (exact [29] and entropic [3]
@@ -119,15 +122,14 @@ Note that for easier access the module is named `ot` instead of `pot`.
119122

120123
### Dependencies
121124

122-
Some sub-modules require additional dependences which are discussed below
125+
Some sub-modules require additional dependencies which are discussed below
123126

124127
* **ot.dr** (Wasserstein dimensionality reduction) depends on autograd and pymanopt that can be installed with:
125128

126129
```shell
127130
pip install pymanopt autograd
128131
```
129132

130-
* **ot.gpu** (GPU accelerated OT) depends on cupy that have to be installed following instructions on [this page](https://docs-cupy.chainer.org/en/stable/install.html). Obviously you will need CUDA installed and a compatible GPU. Note that this module is deprecated since version 0.8 and will be deleted in the future. GPU is now handled automatically through the backends and several solver already can run on GPU using the Pytorch backend.
131133

132134
## Examples
133135

RELEASES.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
#### New features
77

8+
- Update examples in the gallery (PR #359).
89
- Add stochastic loss and OT plan computation for regularized OT and
910
backend examples(PR #360).
1011
- Implementation of factored OT with emd and sinkhorn (PR #358).
@@ -254,7 +255,7 @@ are coming for the next versions.
254255

255256
#### Closed issues
256257

257-
- Add JMLR paper to teh readme ad Mathieu Blondel to the Acknoledgments (PR
258+
- Add JMLR paper to the readme and Mathieu Blondel to the Acknoledgments (PR
258259
#231, #232)
259260
- Bug in Unbalanced OT example (Issue #127)
260261
- Clean Cython output when calling setup.py clean (Issue #122)

docs/source/_static/images/logo.png

-713 Bytes
Loading

0 commit comments

Comments
 (0)