Contributor

The docstrings for lowrank_gromov_wasserstein_samples and lowrank_sinkhorn have inaccuracies. I modified the docstring to match the actual usage.

In lowrank_gromov_wasserstein_samples:

1. The matrix B should have dimensions (dim_b, dim_b) not (dim_a, dim_a)
2. alpha is a float, not an int
3. rescale_cost is True by default, not False
4. numItermax_dykstra is 10000 by default, not 2000
5. stopThr_dykstra is 1e-3 by default, not 1e-7

In lowrank_sinkhorn:

1. rescale_cost is True by default, not False

PR checklist

• I have read the CONTRIBUTING document.
• The documentation is up-to-date with the changes I made (check build artifacts).
• All tests passed, and additional code has been covered with new tests.
• I have added the PR and Issue fix to the RELEASES.md file.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.85%. Comparing base (2467702) to head (08e21ba).

@@           Coverage Diff           @@
##           master     #823   +/-   ##
=======================================
  Coverage   96.85%   96.85%
=======================================
  Files         124      124
  Lines       24840    24840
=======================================
  Hits        24059    24059
  Misses        781      781           

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Collaborator

Hello @akprasadan , thanks for the PR. I'm OK with merging it but you need to add a line in the RELEASES.md file describing the PR what you did and the PR number. This is important because it logs all that we did between releases and the contributors can do it better than me.