search

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

expose `SinkhornDivergenceOutput` #584

Closed marcocuturi closed 1 month ago

marcocuturi commented 1 month ago

put SinkhornDivergenceOutput in the docs, rename sinkhorn_kwargs to solve_kwargs since those are parameters passed on to linear.solve()

review-notebook-app[bot] commented 1 month ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.87%. Comparing base (b36a937) to head (f858872). Report is 2 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/ott-jax/ott/pull/584/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/584?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 #584 +/- ## ========================================== - Coverage 87.87% 87.87% -0.01% ========================================== Files 73 73 Lines 7813 7812 -1 Branches 1127 779 -348 ========================================== - Hits 6866 6865 -1 Misses 794 794 Partials 153 153 ``` | [Files with missing lines](https://app.codecov.io/gh/ott-jax/ott/pull/584?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/tools/progot.py](https://app.codecov.io/gh/ott-jax/ott/pull/584?src=pr&el=tree&filepath=src%2Fott%2Ftools%2Fprogot.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax#diff-c3JjL290dC90b29scy9wcm9nb3QucHk=) | `29.16% <ø> (ø)` | | | [src/ott/tools/segment\_sinkhorn.py](https://app.codecov.io/gh/ott-jax/ott/pull/584?src=pr&el=tree&filepath=src%2Fott%2Ftools%2Fsegment_sinkhorn.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax#diff-c3JjL290dC90b29scy9zZWdtZW50X3Npbmtob3JuLnB5) | `100.00% <ø> (ø)` | | | [src/ott/tools/sinkhorn\_divergence.py](https://app.codecov.io/gh/ott-jax/ott/pull/584?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) | `91.86% <ø> (ø)` | | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/ott-jax/ott/pull/584/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ott-jax)