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

SIRT - documentation unclear for default values for initial #1895

Closed
MargaretDuff opened this issue Aug 16, 2024 · 0 comments · Fixed by #1906
Closed

SIRT - documentation unclear for default values for initial #1895

MargaretDuff opened this issue Aug 16, 2024 · 0 comments · Fixed by #1906
Assignees
Labels
bug Something isn't working documentation
Milestone

Comments

@MargaretDuff
Copy link
Member

Description

The documentation suggests that there is a default value for initial

initial : DataContainer, default = None
Starting point of the algorithm, default value = Zero DataContainer
operator : LinearOperator
The operator A.
data : DataContainer
The data b.
lower : :obj:`float`, default = None
Lower bound constraint
upper : :obj:`float`, default = None
Upper bound constraint
constraint : Function, default = None
A function with :code:`proximal` method, e.g., :class:`.IndicatorBox` function and :meth:`.IndicatorBox.proximal`,
or :class:`.TotalVariation` function and :meth:`.TotalVariation.proximal`.

However, the code requires that it is passed:
image

Environment

import cil, sys
print(cil.version.version, cil.version.commit_hash, sys.version, sys.platform)
@MargaretDuff MargaretDuff added bug Something isn't working documentation labels Aug 16, 2024
@gfardell gfardell added this to the v24.2.0 milestone Sep 18, 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 documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants