Add docs for scico.solver module
#202
Conversation
Codecov Report
@@ Coverage Diff @@
## main #202 +/- ##
==========================================
- Coverage 92.24% 92.22% -0.02%
==========================================
Files 48 48
Lines 3351 3345 -6
==========================================
- Hits 3091 3085 -6
Misses 260 260
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
scico/functional/_indicator.py
Outdated
| @@ -50,17 +48,17 @@ def prox( | |||
| self, v: Union[JaxArray, BlockArray], lam: float = 1.0, **kwargs | |||
| ) -> Union[JaxArray, BlockArray]: | |||
| r"""Evaluate the scaled proximal operator of the indicator over | |||
| the non-negative orthant, :math:`I_{>= 0} `,: | |||
| the non-negative orthant, :math:`I_{>= 0}` | |||
There was a problem hiding this comment.
I think there needs to be some connector here, because the equation on the following lines is part of this sentence (and is an independent clause)
scico/solver.py
Outdated
| # All rights reserved. BSD 3-clause License. | ||
| # This file is part of the SCICO package. Details of the copyright and | ||
| # user license can be found in the 'LICENSE' file distributed with the | ||
| # package. | ||
|
|
||
| """Optimization algorithms.""" | ||
| """Optimization algorithms. |
There was a problem hiding this comment.
Suggestion: "Scipy optimization algorithms" or similar to differentiate between this and scico.optimize which currently has the same description.
There was a problem hiding this comment.
Very good point. Done.
|
|
||
| This module provides scico interface wrappers for functions | ||
| from :mod:`scipy.optimize` since jax directly implements only a very | ||
| limited subset of these functions (there is limited, experimental support |
There was a problem hiding this comment.
missing closing parenthesis
There was a problem hiding this comment.
Good catch - fixed.
Resolves #123.
In addition:
__author__attributes in a number of files