Skip to content
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

add glossary #594

Merged
merged 8 commits into from
Nov 8, 2024
Merged

add glossary #594

merged 8 commits into from
Nov 8, 2024

Conversation

marcocuturi
Copy link
Contributor

@marcocuturi marcocuturi commented Nov 4, 2024

adds a glossary.rst file and modifies documentation in multiple files to refer to terms in that glossary

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.13%. Comparing base (c9d3a49) to head (f472973).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #594   +/-   ##
=======================================
  Coverage   88.13%   88.13%           
=======================================
  Files          73       73           
  Lines        7768     7768           
  Branches      556      556           
=======================================
  Hits         6846     6846           
  Misses        779      779           
  Partials      143      143           
Files with missing lines Coverage Δ
src/ott/neural/methods/expectile_neural_dual.py 0.00% <ø> (ø)
src/ott/neural/methods/monge_gap.py 91.20% <ø> (ø)
src/ott/solvers/linear/implicit_differentiation.py 88.76% <ø> (ø)
src/ott/solvers/linear/sinkhorn.py 99.38% <ø> (ø)
src/ott/solvers/quadratic/gromov_wasserstein.py 88.42% <ø> (ø)

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@marcocuturi marcocuturi requested a review from michalk8 November 6, 2024 01:27
@michalk8 michalk8 added the documentation Improvements or additions to documentation label Nov 8, 2024
src/ott/solvers/linear/implicit_differentiation.py Outdated Show resolved Hide resolved
docs/tutorials/neural/000_neural_dual copy.ipynb Outdated Show resolved Hide resolved
docs/glossary.rst Show resolved Hide resolved
docs/glossary.rst Show resolved Hide resolved
docs/glossary.rst Show resolved Hide resolved
docs/glossary.rst Outdated Show resolved Hide resolved
docs/glossary.rst Show resolved Hide resolved
docs/glossary.rst Show resolved Hide resolved
docs/glossary.rst Outdated Show resolved Hide resolved
@marcocuturi
Copy link
Contributor Author

thanks @michalk8 ! please feel free to merge directly if you are ok.

docs/glossary.rst Outdated Show resolved Hide resolved
docs/glossary.rst Outdated Show resolved Hide resolved
docs/tutorials/neural/000_neural_dual copy.ipynb Outdated Show resolved Hide resolved
Copy link
Collaborator

@michalk8 michalk8 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks a lot!

@michalk8 michalk8 merged commit e88f61f into main Nov 8, 2024
10 of 12 checks passed
@michalk8 michalk8 deleted the glossary branch November 8, 2024 23:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants