-
Notifications
You must be signed in to change notification settings - Fork 44
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
Fix FISTA and ISTA maths in docs #2012
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.
Thanks Laura!
On lines 40-41 please can we replace "where :math:f
is differentiable, :math:g
has a simple proximal operator and :math:\alpha^k
is the :code:step_size
per iteration."
with
"where :math:f
is differentiable, :math:g
has a simple proximal operator and :math:\alpha
is the :code:step_size
."
and do the same for FISTA, if required.
Co-authored-by: Margaret Duff <43645617+MargaretDuff@users.noreply.github.com> Signed-off-by: Laura Murgatroyd <60604372+lauramurgatroyd@users.noreply.github.com>
Being picky now, please could we rearrange the intro to FISTA/ISTA so it reads:
I think this gets the important information over quicker: what the algorithm does and what is required from the functions. Being very picky, we should also not start a sentence with a mathematical expression. Words like "Where", "For" etc. can be used to start a sentence |
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.
Thanks @lauramurgatroyd
Description
Closes #2013
Changes
Updated FISTA docs:
Updated ISTA docs:
Related issues/links
Closes #2013
Checklist
Contribution Notes
Please read and adhere to the developer guide and local patterns and conventions.