@@ -59,11 +59,11 @@ def solve(M, a=None, b=None, reg=None, reg_type="KL", unbalanced=None,
59
59
Unbalanced penalization weight :math:`\lambda_u`, by default None
60
60
(balanced OT)
61
61
unbalanced_type : str, optional
62
- Type of unbalanced penalization unction :math:`U` either "KL", "L2", "TV", by default "KL"
62
+ Type of unbalanced penalization function :math:`U` either "KL", "L2", "TV", by default "KL"
63
63
n_threads : int, optional
64
64
Number of OMP threads for exact OT solver, by default 1
65
65
max_iter : int, optional
66
- Maximum number of iteration , by default None (default values in each solvers)
66
+ Maximum number of iterations , by default None (default values in each solvers)
67
67
plan_init : array_like, shape (dim_a, dim_b), optional
68
68
Initialization of the OT plan for iterative methods, by default None
69
69
potentials_init : (array_like(dim_a,),array_like(dim_b,)), optional
@@ -391,30 +391,29 @@ def solve_gromov(Ca, Cb, M=None, a=None, b=None, loss='L2', symmetric=None,
391
391
Type of loss function, either ``"L2"`` or ``"KL"``, by default ``"L2"``
392
392
symmetric : bool, optional
393
393
Use symmetric version of the Gromov-Wasserstein problem, by default None
394
- tests wether the matrices are symmetric or True/False to avoid the test.
394
+ tests whether the matrices are symmetric or True/False to avoid the test.
395
395
reg : float, optional
396
396
Regularization weight :math:`\lambda_r`, by default None (no reg., exact
397
397
OT)
398
398
reg_type : str, optional
399
- Type of regularization :math:`R`, by default "entropic " (only used when
399
+ Type of regularization :math:`R`, by default "entropy " (only used when
400
400
``reg!=None``)
401
401
alpha : float, optional
402
402
Weight the quadratic term (alpha*Gromov) and the linear term
403
403
((1-alpha)*Wass) in the Fused Gromov-Wasserstein problem. Not used for
404
404
Gromov problem (when M is not provided). By default ``alpha=None``
405
- corresponds to to
406
- ``alpha=1`` for Gromov problem (``M==None``) and ``alpha=0.5`` for Fused
407
- Gromov-Wasserstein problem (``M!=None``)
405
+ corresponds to ``alpha=1`` for Gromov problem (``M==None``) and
406
+ ``alpha=0.5`` for Fused Gromov-Wasserstein problem (``M!=None``)
408
407
unbalanced : float, optional
409
408
Unbalanced penalization weight :math:`\lambda_u`, by default None
410
409
(balanced OT), Not implemented yet
411
410
unbalanced_type : str, optional
412
- Type of unbalanced penalization unction :math:`U` either "KL", "semirelaxed",
413
- "partial", by default "KL" , Not implemented yet
411
+ Type of unbalanced penalization function :math:`U` either "KL", "semirelaxed",
412
+ "partial", by default "KL" but note that it is not implemented yet.
414
413
n_threads : int, optional
415
414
Number of OMP threads for exact OT solver, by default 1
416
415
max_iter : int, optional
417
- Maximum number of iteration , by default None (default values in each
416
+ Maximum number of iterations , by default None (default values in each
418
417
solvers)
419
418
plan_init : array_like, shape (dim_a, dim_b), optional
420
419
Initialization of the OT plan for iterative methods, by default None
0 commit comments