diff options
author | Oleksii Kachaiev <kachayev@gmail.com> | 2023-05-03 10:36:09 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-03 10:36:09 +0200 |
commit | 2aeb591be6b19a93f187516495ed15f1a47be925 (patch) | |
tree | 9a6f759856a3f6b2d7c6db3514927ba3e5af10b5 /ot/coot.py | |
parent | 8a7035bdaa5bb164d1c16febbd83650d1fb6d393 (diff) |
[DOC] Corrected spelling errors (#467)
* Fix typos in docstrings and examples
* A few more fixes
* Fix ref for `center_ot_dual` function
* Another typo
* Fix titles formatting
* Explicit empty line after math blocks
* Typo: asymmetric
* Fix code cell formatting for 1D barycenters
* Empirical
* Fix indentation for references
* Fixed all WARNINGs about title formatting
* Fix empty lines after math blocks
* Fix whitespace line
* Update changelog
* Consistent Gromov-Wasserstein
* More Gromov-Wasserstein consistency
---------
Co-authored-by: RĂ©mi Flamary <remi.flamary@gmail.com>
Diffstat (limited to 'ot/coot.py')
-rw-r--r-- | ot/coot.py | 9 |
1 files changed, 4 insertions, 5 deletions
@@ -74,7 +74,7 @@ def co_optimal_transport(X, Y, wx_samp=None, wx_feat=None, wy_samp=None, wy_feat Sinkhorn solver. If epsilon is scalar, then the same epsilon is applied to both regularization of sample and feature couplings. alpha : scalar or indexable object of length 2, float or int, optional (default = 0) - Coeffficient parameter of linear terms with respect to the sample and feature couplings. + Coefficient parameter of linear terms with respect to the sample and feature couplings. If alpha is scalar, then the same alpha is applied to both linear terms. M_samp : (n_sample_x, n_sample_y), float, optional (default = None) Sample matrix with respect to the linear term on sample coupling. @@ -295,7 +295,7 @@ def co_optimal_transport2(X, Y, wx_samp=None, wx_feat=None, wy_samp=None, wy_fea + \varepsilon_1 \mathbf{KL}(\mathbf{P} | \mathbf{w}_{xs} \mathbf{w}_{ys}^T) + \varepsilon_2 \mathbf{KL}(\mathbf{Q} | \mathbf{w}_{xf} \mathbf{w}_{yf}^T) - Where : + where : - :math:`\mathbf{X}`: Data matrix in the source space - :math:`\mathbf{Y}`: Data matrix in the target space @@ -333,7 +333,7 @@ def co_optimal_transport2(X, Y, wx_samp=None, wx_feat=None, wy_samp=None, wy_fea Sinkhorn solver. If epsilon is scalar, then the same epsilon is applied to both regularization of sample and feature couplings. alpha : scalar or indexable object of length 2, float or int, optional (default = 0) - Coeffficient parameter of linear terms with respect to the sample and feature couplings. + Coefficient parameter of linear terms with respect to the sample and feature couplings. If alpha is scalar, then the same alpha is applied to both linear terms. M_samp : (n_sample_x, n_sample_y), float, optional (default = None) Sample matrix with respect to the linear term on sample coupling. @@ -345,7 +345,6 @@ def co_optimal_transport2(X, Y, wx_samp=None, wx_feat=None, wy_samp=None, wy_fea tuples of 2 vectors of size (n_sample_x, n_sample_y) and (n_feature_x, n_feature_y). Initialization of sample and feature dual vectors if using Sinkhorn algorithm. Zero vectors by default. - - "pi_sample" and "pi_feature" whose values are matrices of size (n_sample_x, n_sample_y) and (n_feature_x, n_feature_y). Initialization of sample and feature couplings. @@ -382,7 +381,7 @@ def co_optimal_transport2(X, Y, wx_samp=None, wx_feat=None, wy_samp=None, wy_fea float CO-Optimal Transport distance. dict - Contains logged informations from :any:`co_optimal_transport` solver. + Contains logged information from :any:`co_optimal_transport` solver. Only returned if `log` parameter is True References |