Skip to content

Commit

Permalink
add note in entropic gw solvers
Browse files Browse the repository at this point in the history
  • Loading branch information
cedricvincentcuaz committed Mar 9, 2023
1 parent 679b74f commit fb86e46
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions ot/gromov/_bregman.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ def entropic_gromov_wasserstein(C1, C2, p, q, loss_fun, epsilon, symmetric=None,
- `L`: loss function to account for the misfit between the similarity matrices
- `H`: entropy
.. note:: If the inner solver `ot.sinkhorn` did not convergence, the
optimal coupling :math:`\mathbf{T}` returned by this function does not
necessarily satisfy the marginal constraints
:math:`\mathbf{T}\mathbf{1}=\mathbf{p}` and
:math:`\mathbf{T}^T\mathbf{1}=\mathbf{q}`. So the returned
Gromov-Wasserstein loss does not necessarily satisfy distance
properties and may be negative.
Parameters
----------
C1 : array-like, shape (ns, ns)
Expand Down Expand Up @@ -76,6 +84,7 @@ def entropic_gromov_wasserstein(C1, C2, p, q, loss_fun, epsilon, symmetric=None,
Print information along iterations
log : bool, optional
Record log if True.
Returns
-------
T : array-like, shape (`ns`, `nt`)
Expand Down Expand Up @@ -163,6 +172,14 @@ def entropic_gromov_wasserstein2(C1, C2, p, q, loss_fun, epsilon, symmetric=None
- `L`: loss function to account for the misfit between the similarity matrices
- `H`: entropy
.. note:: If the inner solver `ot.sinkhorn` did not convergence, the
optimal coupling :math:`\mathbf{T}` returned by this function does not
necessarily satisfy the marginal constraints
:math:`\mathbf{T}\mathbf{1}=\mathbf{p}` and
:math:`\mathbf{T}^T\mathbf{1}=\mathbf{q}`. So the returned
Gromov-Wasserstein loss does not necessarily satisfy distance
properties and may be negative.
Parameters
----------
C1 : array-like, shape (ns, ns)
Expand Down

0 comments on commit fb86e46

Please sign in to comment.