Update docstrings for ADMM - #2367
Open
MargaretDuff wants to merge 2 commits into
Open
MargaretDuff wants to merge 2 commits into
MargaretDuff wants to merge 2 commits into
Conversation
Member
Author
|
lauramurgatroyd
approved these changes
Sep 24, 2026
lauramurgatroyd
left a comment
lauramurgatroyd
left a comment
Member
There was a problem hiding this comment.
Just some suggested changes
Please also update the change log
| @@ -56,22 +56,16 @@ class LADMM(Algorithm): | |||
| operator: CIL Linear Operator | |||
Member
There was a problem hiding this comment.
please could the parameters be rearranged to match the order in the init?
| \min_{x} f(x) + g(y), \text{ subject to } Ax + By = b | ||
| \min_{x,y} f(x) + g(y), \text{ subject to } Ax + By = b | ||
|
|
||
| In CIL, we have implemented the case where :math:`A = K`, :math:`B = -Id`, :math:`b = 0` which gives |
| Initial guess | ||
|
|
||
|
|
||
| Note |
Member
There was a problem hiding this comment.
Could any similarity to PDHG still be commented on?
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
The issue is in #2366 - updates the incorrect docs
Testing you performed
Related issues/links
Closes #2366
Checklist