diff options
| author | Mokhtar Z. Alaya <mzalaya@sct-18-1bee-1581.univ-rouen.fr> | 2020-01-10 12:17:45 +0100 |
|---|---|---|
| committer | Mokhtar Z. Alaya <mzalaya@sct-18-1bee-1581.univ-rouen.fr> | 2020-01-10 12:17:45 +0100 |
| commit | 0461fb539b23d90d772fe5c4dd75463f915a1da5 (patch) | |
| tree | 9359d944b524995c5aa9eb64115011991924dbe0 /ot/bregman.py | |
| parent | cadd301c4de54332378159ab55a02a48beb1d753 (diff) | |
improve doc
Diffstat (limited to 'ot/bregman.py')
| -rw-r--r-- | ot/bregman.py | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/ot/bregman.py b/ot/bregman.py index 0f02226..16012b5 100644 --- a/ot/bregman.py +++ b/ot/bregman.py @@ -1833,7 +1833,7 @@ def screenkhorn(a, b, M, reg, ns_budget=None, nt_budget=None, uniform=False, res If it is None then 50% of the target sample points will be keeped uniform : `bool`, default=False - If `True`, the source and target distribution are supposed to be uniform, namely a_i = 1 / ns and b_j = 1 / nt. + If `True`, the source and target distribution are supposed to be uniform, i.e., a_i = 1 / ns and b_j = 1 / nt restricted : `bool`, default=True If `True`, a warm-start initialization for the L-BFGS-B solver @@ -1848,8 +1848,9 @@ def screenkhorn(a, b, M, reg, ns_budget=None, nt_budget=None, uniform=False, res pgtol : `float`, default=1e-09 Final objective function accuracy in LBFGS solver - verbose: `bool`, default=False - If `True`, dispaly informations along iterations + verbose : `bool`, default=False + If `True`, dispaly informations about the cardinals of the active sets and the paramerters kappa + and epsilon Dependency ---------- @@ -2116,4 +2117,4 @@ def screenkhorn(a, b, M, reg, ns_budget=None, nt_budget=None, uniform=False, res if log: return gamma, log else: - return gamma + return gamma
\ No newline at end of file |