Skip to content

[DOC] Minor suggestions for the Gromov Wasserstein docstring #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 18, 2025

Conversation

tatsuookubo
Copy link
Contributor

Types of changes

Motivation and context / Related issue

In ot.gromov, I propose minor changes in the docstring:

  • Changing "conjugate gradient" to "conditional gradient"
  • Making the mathematical notation consistent in gromov_wasserstein and gromov_wasserstein2 by changing from \gamma to T for the transportation plan in the constraints.
    Thank you for your consideration!

How has this been tested (if it applies)

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.

Copy link

codecov bot commented May 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.09%. Comparing base (61e9af4) to head (b6c5438).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #737   +/-   ##
=======================================
  Coverage   97.09%   97.09%           
=======================================
  Files         100      100           
  Lines       20432    20432           
=======================================
  Hits        19839    19839           
  Misses        593      593           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cedricvincentcuaz
Copy link
Collaborator

Dear @tatsuookubo ,
Thank you for correcting these inconsistent notations in the documentation. I will merge the PR.
Best,
Cédric

@cedricvincentcuaz cedricvincentcuaz merged commit f42b487 into PythonOT:master May 18, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants