Skip to content

Commit 9c314ec

Browse files
improve doc
1 parent 63c9d2d commit 9c314ec

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

ot/unbalanced/_lbfgs.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,8 @@ def lbfgsb_unbalanced(
219219
'kl' (Kullback-Leibler) or 'l2' (half-squared) or a tuple
220220
of two callable functions returning the reg term and its derivative.
221221
Note that the callable functions should be able to handle Numpy arrays
222-
and not tensors from the backend
222+
and not tensors from the backend, otherwise functions will be converted to Numpy
223+
leading to a computational overhead.
223224
regm_div: string, optional (default = 'kl')
224225
Divergence to quantify the difference between the marginals.
225226
Can take three values: 'kl' (Kullback-Leibler) or 'l2' (half-squared) or 'tv' (Total Variation)
@@ -407,7 +408,8 @@ def lbfgsb_unbalanced2(
407408
'kl' (Kullback-Leibler) or 'l2' (half-squared) or a tuple
408409
of two callable functions returning the reg term and its derivative.
409410
Note that the callable functions should be able to handle Numpy arrays
410-
and not tensors from the backend
411+
and not tensors from the backend, otherwise functions will be converted to Numpy
412+
leading to a computational overhead.
411413
regm_div: string, optional (default = 'kl')
412414
Divergence to quantify the difference between the marginals.
413415
Can take three values: 'kl' (Kullback-Leibler) or 'l2' (half-squared) or 'tv' (Total Variation)

0 commit comments

Comments
 (0)