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.

Sign up for GitHub

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

Jump to bottom

Sirt documentation improvements #1959

Merged
merged 8 commits into from
Oct 30, 2024
Merged

Sirt documentation improvements #1959

merged 8 commits into from
Oct 30, 2024

Conversation

MargaretDuff
Copy link
Member

@MargaretDuff MargaretDuff commented Oct 17, 2024 •
edited
Loading

Changes

  • Removed the confusing *s
  • Added a missing transpose
  • made the example equation consistent with the code

Testing you performed

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

Related issues/links

Closes #1957

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
Copy link
Member Author

image
image
image

@MargaretDuff MargaretDuff self-assigned this Oct 18, 2024
@MargaretDuff MargaretDuff added this to the v24.3.0 milestone Oct 18, 2024
lauramurgatroyd
lauramurgatroyd requested changes Oct 18, 2024
View reviewed changes
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.

The SIRT example uses

Wrappers/Python/cil/optimisation/algorithms/SIRT.py Outdated Show resolved Hide resolved
Wrappers/Python/cil/optimisation/algorithms/SIRT.py Outdated Show resolved Hide resolved
hrobarts
hrobarts reviewed Oct 23, 2024
View reviewed changes
Copy link
Contributor

@hrobarts hrobarts left a comment

Choose a reason for hiding this comment

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

Looks like a helpful update! Just a couple of questions.

Wrappers/Python/cil/optimisation/algorithms/SIRT.py Outdated Show resolved Hide resolved
Wrappers/Python/cil/optimisation/algorithms/SIRT.py Show resolved Hide resolved
Wrappers/Python/cil/optimisation/algorithms/SIRT.py Outdated Show resolved Hide resolved
@MargaretDuff
Copy link
Member Author

Thanks @hrobarts - they were all good spots! Have updated the relevant lines

@MargaretDuff
Copy link
Member Author

MargaretDuff commented Oct 29, 2024 •
edited
Loading

@hrobarts @lauramurgatroyd The documentation is now:
image
(Ignore the first duplicate here - that is just my screen shot!)
image
image

@hrobarts
Copy link
Contributor

Looks good to me :) thanks Margaret

@MargaretDuff MargaretDuff enabled auto-merge (squash) October 30, 2024 09:49
@MargaretDuff MargaretDuff merged commit 5d569dc into TomographicImaging:master Oct 30, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hrobarts hrobarts hrobarts approved these changes

@lauramurgatroyd lauramurgatroyd lauramurgatroyd approved these changes

Assignees

@MargaretDuff MargaretDuff

Labels
Waiting for review
Projects
None yet
Milestone
v24.3.0
Development

Successfully merging this pull request may close these issues.

SIRT documentation example
3 participants
@MargaretDuff @hrobarts @lauramurgatroyd