Skip to content

Commit 1262563

Browse files
committed
update readme + doc
1 parent 63fd11e commit 1262563

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

ot/da.py

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@ def OT_mapping_linear(xs, xt, reg=1e-6, ws=None,
643643
The function estimate the optimal linear operator that align the two
644644
empirical distributions. This is equivalent to estimating the closed
645645
form mapping between two Gaussian distribution :math:`N(\mu_s,\Sigma_s)`
646-
and :math:`N(\mu_t,\Sigma_t)` as proposed in [14].
646+
and :math:`N(\mu_t,\Sigma_t)` as proposed in [14] and discussed in remark 2.29 in [15].
647647
648648
The linear operator from source to target :math:`M`
649649
@@ -692,6 +692,9 @@ def OT_mapping_linear(xs, xt, reg=1e-6, ws=None,
692692
.. [14] Knott, M. and Smith, C. S. "On the optimal mapping of
693693
distributions", Journal of Optimization Theory and Applications
694694
Vol 43, 1984
695+
696+
.. [15] Peyré, G., & Cuturi, M. (2017). "Computational Optimal
697+
Transport", 2018.
695698
696699
697700
"""
@@ -1290,7 +1293,8 @@ class LinearTransport(BaseTransport):
12901293
The function estimate the optimal linear operator that align the two
12911294
empirical distributions. This is equivalent to estimating the closed
12921295
form mapping between two Gaussian distribution :math:`N(\mu_s,\Sigma_s)`
1293-
and :math:`N(\mu_t,\Sigma_t)` as proposed in [14].
1296+
and :math:`N(\mu_t,\Sigma_t)` as proposed in [14] and discussed in
1297+
remark 2.29 in [15].
12941298
12951299
The linear operator from source to target :math:`M`
12961300
@@ -1314,6 +1318,15 @@ class LinearTransport(BaseTransport):
13141318
log : bool, optional
13151319
record log if True
13161320
1321+
References
1322+
----------
1323+
1324+
.. [14] Knott, M. and Smith, C. S. "On the optimal mapping of
1325+
distributions", Journal of Optimization Theory and Applications
1326+
Vol 43, 1984
1327+
1328+
.. [15] Peyré, G., & Cuturi, M. (2017). "Computational Optimal
1329+
Transport", 2018.
13171330
13181331
"""
13191332

0 commit comments

Comments
 (0)