Minor improvements to scico.optimize docs
#328
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #328 +/- ##
=======================================
Coverage 93.88% 93.88%
=======================================
Files 55 55
Lines 3451 3451
=======================================
Hits 3240 3240
Misses 211 211
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
scico/optimize/_ladmm.py
Outdated
| @@ -217,7 +217,7 @@ def norm_primal_residual(self, x: Optional[Union[JaxArray, BlockArray]] = None) | |||
| :code:`self.x`. | |||
|
|
|||
| Returns: | |||
| Current value of primal residual. | |||
| Value of primal residual. | |||
There was a problem hiding this comment.
norm of the residual or the residual?
scico/optimize/_admm.py
Outdated
| @@ -252,7 +252,7 @@ def norm_primal_residual(self, x: Optional[Union[JaxArray, BlockArray]] = None) | |||
| current iterate :code:`self.x`. | |||
|
|
|||
| Returns: | |||
| Current value of primal residual. | |||
| Value of primal residual. | |||
There was a problem hiding this comment.
norm of the residual or the residual?
Michael-T-McCann
approved these changes
Aug 31, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor improvements to
scico.optimizedocs.