-
Notifications
You must be signed in to change notification settings - Fork 41
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
Sirt documentation improvements #1959
base: master
Are you sure you want to change the base?
Sirt documentation improvements #1959
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The SIRT example uses
|
||
|
||
Examples | ||
-------- | ||
.. math:: \underset{x}{\mathrm{argmin}} \frac{1}{2}\| x - d\|^{2} | ||
.. math:: \underset{x}{\mathrm{argmin}} \frac{1}{2}\| Ax - d\|^{2} | ||
|
||
>>> sirt = SIRT(initial = ig.allocate(0), operator = A, data = d, max_iteration = 5) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
>>> sirt = SIRT(initial = ig.allocate(0), operator = A, data = d, max_iteration = 5) | |
>>> sirt = SIRT(initial = ig.allocate(0), operator = A, data = d) |
I think we're moving away from using max_iteration?
@@ -198,7 +201,7 @@ def update(self): | |||
|
|||
r""" Performs a single iteration of the SIRT algorithm | |||
|
|||
.. math:: x^{k+1} = \mathrm{proj}_{C}( x^{k} + \omega * D ( A^{T} ( M * (b - Ax) ) ) ) | |||
.. math:: x^{k+1} = \mathrm{proj}_{C}( x^{k} + \omega D ( A^{T} ( M (b - Ax) ) ) ) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.. math:: x^{k+1} = \mathrm{proj}_{C}( x^{k} + \omega D ( A^{T} ( M (b - Ax) ) ) ) | |
.. math:: x^{k+1} = \mathrm{proj}_{C}( x^{k} + \omega D ( A^{T} ( M (b - Ax^{k}) ) ) ) |
Changes
Testing you performed
Related issues/links
Closes #1957
Checklist
[] I have implemented unit tests that cover any new or modified functionality[ ] CHANGELOG.md has been updated with any functionality changeContribution Notes
Please read and adhere to the developer guide and local patterns and conventions.