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

Update examples #540

Merged
merged 38 commits into from
Jul 19, 2024
Merged
Changes from 1 commit
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
f3ad2b9
Minor comment edits
bwohlberg Jun 4, 2024
c2efef5
Fix missing typing import
bwohlberg Jun 5, 2024
fd012fa
Docs fixes
bwohlberg Jun 5, 2024
d5820e3
Improve docs
bwohlberg Jun 6, 2024
d518af1
Docs fixes
bwohlberg Jun 6, 2024
e01f1b6
Add missing dependency (due to recent changes in other packages) for …
bwohlberg Jun 6, 2024
9c4131b
Update submodule
bwohlberg Jun 6, 2024
e40615a
Fix script to notebook conversion bug
bwohlberg Jun 6, 2024
cbec0cf
Update submodule
Jun 6, 2024
5124e62
Update submodule
Jun 6, 2024
b64f977
Update submodule
bwohlberg Jun 6, 2024
a46200c
Update submodule
Jun 6, 2024
9c5d6a7
Add missing dependency for building notebooks
bwohlberg Jun 7, 2024
58673b3
Merge branch 'main' into brendt/examples
bwohlberg Jun 13, 2024
4c3a195
Update submodule
Jun 13, 2024
5e38ca8
Improve example script docstring
bwohlberg Jun 13, 2024
abd683d
Update submodule
bwohlberg Jun 13, 2024
80ac628
Avoid ray complaints
bwohlberg Jun 13, 2024
822cef8
Remove second ray.init call
bwohlberg Jun 13, 2024
f72adbe
Update submodule
bwohlberg Jun 17, 2024
782de2c
Merge branch 'main' into brendt/examples
bwohlberg Jun 17, 2024
6bee347
Update submodule
Jun 18, 2024
020214a
Update submodule
bwohlberg Jun 18, 2024
c1e5e07
Merge branch 'brendt/examples' of github.com:lanl/scico into brendt/e…
bwohlberg Jun 18, 2024
503b6d5
Replace deprecated matplotlib method
bwohlberg Jun 19, 2024
9917021
Merge branch 'main' into brendt/examples
bwohlberg Jul 9, 2024
e7a27a9
Update submodule
Jul 9, 2024
2829fcb
Update submodule
Jul 9, 2024
0eb31fd
Remove largely redundant example
bwohlberg Jul 9, 2024
ab90d40
Update example index
bwohlberg Jul 9, 2024
be7fb76
Rename example script
bwohlberg Jul 9, 2024
d4285d1
Edit script title and fix docs
bwohlberg Jul 9, 2024
f17ac18
Update example index
bwohlberg Jul 9, 2024
275ef2c
Update submodule
bwohlberg Jul 9, 2024
92d4dff
Merge branch 'brendt/examples' of github.com:lanl/scico into brendt/e…
bwohlberg Jul 9, 2024
803b836
Update submodule
bwohlberg Jul 19, 2024
2bf79a9
void doctest errors resulting from unimportable astra or svmbir
bwohlberg Jul 19, 2024
1c0cb42
Avoid doctest errors resulting from unimportable astra or svmbir
bwohlberg Jul 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Docs fixes
  • Loading branch information
bwohlberg committed Jun 5, 2024
commit fd012fa3d20e22b7f077f8bccd0e3dee189fe7aa
22 changes: 12 additions & 10 deletions scico/optimize/_pgm.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
# Copyright (C) 2020-2023 by SCICO Developers
# Copyright (C) 2020-2024 by SCICO Developers
# 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
Expand Down Expand Up @@ -35,9 +35,9 @@ class PGM(Optimizer):
Minimize a function of the form :math:`f(\mb{x}) + g(\mb{x})`, where
:math:`f` and the :math:`g` are instances of :class:`.Functional`.

Uses helper :class:`StepSize` to provide an estimate of the Lipschitz
Uses :class:`.PGMStepSize` helper classes to estimate the Lipschitz
constant :math:`L` of :math:`f`. The step size :math:`\alpha` is the
reciprocal of :math:`L`, i.e.: :math:`\alpha = 1 / L`.
reciprocal of :math:`L`, i.e. :math:`\alpha = 1 / L`.
"""

def __init__(
Expand All @@ -52,12 +52,13 @@ def __init__(
r"""

Args:
f: Loss or Functional object with `grad` defined.
g: Instance of Functional with defined prox method.
f: Instance of :class:`.Loss` or :class:`.Functional` with
defined `grad` method.
g: Instance of :class:`.Functional` with defined prox method.
L0: Initial estimate of Lipschitz constant of f.
x0: Starting point for :math:`\mb{x}`.
step_size: helper :class:`StepSize` to estimate the Lipschitz
constant of f.
step_size: helper :class:`.PGMStepSize` to estimate the
Lipschitz constant of f.
**kwargs: Additional optional parameters handled by
initializer of base class :class:`.Optimizer`.
"""
Expand Down Expand Up @@ -173,11 +174,12 @@ def __init__(
):
r"""
Args:
f: Loss or Functional object with `grad` defined.
g: Instance of Functional with defined prox method.
f: Instance of :class:`.Loss` or :class:`.Functional` with
defined `grad` method.
g: Instance of :class:`.Functional` with defined prox method.
L0: Initial estimate of Lipschitz constant of f.
x0: Starting point for :math:`\mb{x}`.
step_size: helper :class:`StepSize` to estimate the Lipschitz
step_size: helper :class:`.PGMStepSize` to estimate the Lipschitz
constant of f.
**kwargs: Additional optional parameters handled by
initializer of base class :class:`.Optimizer`.
Expand Down