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

Maths in FISTA and ISTA documentation is incorrect/inconsistent #2013

Closed
lauramurgatroyd opened this issue Dec 11, 2024 · 0 comments · Fixed by #2012
Closed

Maths in FISTA and ISTA documentation is incorrect/inconsistent #2013

lauramurgatroyd opened this issue Dec 11, 2024 · 0 comments · Fixed by #2012
Assignees
Labels
bug Something isn't working

Comments

@lauramurgatroyd
Copy link
Member

lauramurgatroyd commented Dec 11, 2024

Description

Current status of ISTA docs:
Image

After discussion with @MargaretDuff we agreed

  • superscripts should be replaced with subscripts to be consistent with FISTA docs
  • we should remove references to alpha_k as it is overcomplicated, not referenced in FISTA docs, and varying step sizes are mentioned instead under the step_size parameter

Current status of FISTA docs:
Image
Image

  • Needs improving to be in line with FISTA paper
  • t_k+1 is calculated but not used - the t__{k-1} in the last equation should be t_{k+1}
  • y_k definition is incorrect and should be removed
  • definition of x_k+1 in update() should instead be x_k and that defn should be used in class docs
  • Add definition of x_0 and y_0 and t_1

Environment

import cil, sys
print(cil.version.version, cil.version.commit_hash, sys.version, sys.platform)
@lauramurgatroyd lauramurgatroyd added the bug Something isn't working label Dec 11, 2024
@lauramurgatroyd lauramurgatroyd self-assigned this Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant