Make prox notation consistent #180
Conversation
Michael-T-McCann
force-pushed
the
mike/prox_notation_75
branch
from
123a5d7
to
7e1581a
Compare
Codecov Report
@@ Coverage Diff @@
## main #180 +/- ##
=======================================
Coverage 92.21% 92.21%
=======================================
Files 48 48
Lines 3352 3352
=======================================
Hits 3091 3091
Misses 261 261
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
scico/functional/_norm.py
Outdated
| lam: Proximal parameter :math:`\lambda`. | ||
| kwargs: Additional arguments that may be used by derived | ||
| classes. These include ``x0``, an initial guess for the | ||
| minimizer. |
There was a problem hiding this comment.
Perhaps worth providing a bit more details on "the minimizer"?
There was a problem hiding this comment.
Good point, x0 shouldn't be mentioned at all in many of these cases. In fact, kwargs is not often used, but I'm not sure how better to document that.
| @@ -97,7 +97,7 @@ def prox( | |||
| lam: Proximal parameter :math:`\lambda`. | |||
| kwargs: Additional arguments that may be used by derived | |||
| classes. These include ``x0``, an initial guess for the | |||
| minimizer. | |||
| minimizer in the defintion of :math:`\mathrm{prox}`. | |||
There was a problem hiding this comment.
Fixed and flyspell-prog-mode added to init.el
scico/functional/_indicator.py
Outdated
| @@ -51,7 +51,7 @@ 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: | |||
| the non-negative orthant, :math:`I`,: | |||
There was a problem hiding this comment.
On its own, perhaps "I" might be confused for the identity matrix? Perhaps write something like I_{[\mb{x} > 0]} to explicitly include the set of which it is the indicator?
Closes #75 .