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

SAG/SAGA documentation rendering and corrections #2011

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

MargaretDuff
Copy link
Member

@MargaretDuff MargaretDuff commented Dec 11, 2024

Changes

  • Fixed the rendering for SAGA warm_start_approximate_gradients
  • Made sure all the sums were from 0 to n-1 not 1 to n-1
  • Split up the notes to make the references clearer

Testing you performed

Please add any demo scripts to https://github.com/TomographicImaging/CIL-Demos/tree/main/misc

Related issues/links

Closes #1969

Checklist

  • I have performed a self-review of my code
  • I have added docstrings in line with the guidance in the developer guide
  • I have updated the relevant documentation
    [ ] I have implemented unit tests that cover any new or modified functionality
    [ ] CHANGELOG.md has been updated with any functionality change
  • Request review from all relevant developers
  • Change pull request label to 'Waiting for review'

Contribution Notes

Please read and adhere to the developer guide and local patterns and conventions.

  • The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in CIL (the Work) under the terms and conditions of the Apache-2.0 License
  • I confirm that the contribution does not violate any intellectual property rights of third parties

@MargaretDuff MargaretDuff linked an issue Dec 11, 2024 that may be closed by this pull request
@MargaretDuff
Copy link
Member Author

MargaretDuff commented Dec 11, 2024

image
image

image
image

@MargaretDuff
Copy link
Member Author

image

Copy link
Member

@lauramurgatroyd lauramurgatroyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You didn't post the most up to date screenshot of SAGA!

Please can you update the rendering of the list of f under the functions parameter

image

Also noticed

image

@MargaretDuff
Copy link
Member Author

Thanks @lauramurgatroyd

I think those things are fixed:
image
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SAGA documentation not rendered correctly
2 participants