ott-jax / ott

Optimal transport tools implemented with the JAX framework, to get differentiable, parallel and jit-able computations.
https://ott-jax.readthedocs.io
Apache License 2.0
524 stars 80 forks source link

introduce `sinkdiv` simplified API, expand glossary with sinkhorn divergence and LR sinkhorn #596

Closed marcocuturi closed 2 days ago

marcocuturi commented 2 days ago

This PR introduces a few enhancements:

review-notebook-app[bot] commented 2 days ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

codecov[bot] commented 2 days ago

Codecov Report

Attention: Patch coverage is 85.71429% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.17%. Comparing base (828acca) to head (b7f8624). Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/ott/tools/plot.py 75.00% 0 Missing and 1 partial :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/ott-jax/ott/pull/596/graphs/tree.svg?width=650&height=150&src=pr&token=14PUIHGLV9&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax)](https://app.codecov.io/gh/ott-jax/ott/pull/596?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax) ```diff @@ Coverage Diff @@ ## main #596 +/- ## ========================================== + Coverage 88.13% 88.17% +0.04% ========================================== Files 73 73 Lines 7768 7770 +2 Branches 556 556 ========================================== + Hits 6846 6851 +5 + Misses 779 778 -1 + Partials 143 141 -2 ``` | [Files with missing lines](https://app.codecov.io/gh/ott-jax/ott/pull/596?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax) | Coverage Δ | | |---|---|---| | [src/ott/solvers/linear/sinkhorn\_lr.py](https://app.codecov.io/gh/ott-jax/ott/pull/596?src=pr&el=tree&filepath=src%2Fott%2Fsolvers%2Flinear%2Fsinkhorn_lr.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax#diff-c3JjL290dC9zb2x2ZXJzL2xpbmVhci9zaW5raG9ybl9sci5weQ==) | `98.98% <ø> (ø)` | | | [src/ott/tools/sinkhorn\_divergence.py](https://app.codecov.io/gh/ott-jax/ott/pull/596?src=pr&el=tree&filepath=src%2Fott%2Ftools%2Fsinkhorn_divergence.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax#diff-c3JjL290dC90b29scy9zaW5raG9ybl9kaXZlcmdlbmNlLnB5) | `94.31% <100.00%> (+2.45%)` | :arrow_up: | | [src/ott/tools/plot.py](https://app.codecov.io/gh/ott-jax/ott/pull/596?src=pr&el=tree&filepath=src%2Fott%2Ftools%2Fplot.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax#diff-c3JjL290dC90b29scy9wbG90LnB5) | `54.09% <75.00%> (ø)` | | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/ott-jax/ott/pull/596/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax)