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

Improve _dual_cone_utils docstrings #250

Merged
merged 4 commits into from
Feb 15, 2025

Conversation

PierreQuinton
Copy link
Contributor

@PierreQuinton PierreQuinton commented Feb 11, 2025

  • Indicate that G must be positive definite
  • Add reference to the definition of pi_J

@PierreQuinton PierreQuinton added docs Improvements or additions to documentation package: aggregation labels Feb 11, 2025
@PierreQuinton PierreQuinton requested a review from a team February 11, 2025 10:29
@PierreQuinton PierreQuinton self-assigned this Feb 11, 2025
Copy link

codecov bot commented Feb 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
src/torchjd/aggregation/_dual_cone_utils.py 100.00% <ø> (ø)

@ValerianRey ValerianRey changed the title docstring of _project_weights now says that G is PD and symmetric. Improve _dual_cone_utils docstrings Feb 11, 2025
@ValerianRey
Copy link
Contributor

I think we should add the same details about G to _project_weight_vector. After that we can squash and merge!

@ValerianRey ValerianRey merged commit 08fefa3 into main Feb 15, 2025
14 checks passed
@ValerianRey ValerianRey deleted the improve_doscstring_project_weights branch February 15, 2025 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation package: aggregation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants