[MRG] Update doc and exemples by rflamary · Pull Request #754 · PythonOT/POT

@rflamary

Types of changes

  • Update readme wity new API
  • Add nice image of contributors to readme and contributors.md
  • Big update of the examples that can now be in multiple sections

Motivation and context / Related issue

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.

@rflamary

@codecov

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.10%. Comparing base (d2ea084) to head (9de93ec).
⚠️ Report is 1 commits behind head on master.

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

@rflamary

@rflamary rflamary changed the title [WIP] Update doc and exemples [MRG] Update doc and exemples

Aug 15, 2025

cedricvincentcuaz

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice update of the documentation :) just spotted a few broken links to example to remove before merging


### Implemented Features

POT provides the following generic OT solvers:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done