summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordecarpentierg <82534773+decarpentierg@users.noreply.github.com>2022-09-12 08:48:16 +0200
committerGitHub <noreply@github.com>2022-09-12 08:48:16 +0200
commitb295ffccc95149c1d63e805e1ca6f027a4071e2a (patch)
tree78b6db57eed7778920759fbc3e421234bec057de
parent982c4a75b225c496432a6a9a19d28c50040bf244 (diff)
update docstring of ot.gromov.init_matrix (#398)
Co-authored-by: Gonzague de Carpentier <decarpentierg@gmail.com>
-rw-r--r--ot/gromov.py7
1 files changed, 5 insertions, 2 deletions
diff --git a/ot/gromov.py b/ot/gromov.py
index 7de8598..bc1c8e5 100644
--- a/ot/gromov.py
+++ b/ot/gromov.py
@@ -70,9 +70,12 @@ def init_matrix(C1, C2, p, q, loss_fun='square_loss'):
Metric cost matrix in the source space
C2 : array-like, shape (nt, nt)
Metric cost matrix in the target space
- T : array-like, shape (ns, nt)
- Coupling between source and target spaces
p : array-like, shape (ns,)
+ Probability distribution in the source space
+ q : array-like, shape (nt,)
+ Probability distribution in the target space
+ loss_fun : str, optional
+ Name of loss function to use: either 'square_loss' or 'kl_loss' (default='square_loss')
Returns
-------