Skip to main content
https://travis-ci.org/fabianp/gdprox.svg?branch=master

gdprox, proximal gradient-descent algorithms

Implements the proximal gradient-descent algorithm for composite objective functions, i.e. functions of the form f(x) + g(x), where f is a smooth function and g is a possibly non-smooth function for which the proximal operator is known.

The main function in this package is gdprox.fmin_cgprox. This function follows a similar interface than the functions in scipy.optimize. The definition of this function is:

def fmin_cgprox(f, fprime, g_prox, x0, rtol=1e-6,
                maxiter=1000, verbose=0, default_step_size=1.):
    """
    proximal gradient-descent solver for optimization problems of the form

                       minimize_x f(x) + g(x)

    where f is a smooth function and g is a (possibly non-smooth)
    function for which the proximal operator is known.

    Parameters
    ----------
    f : callable
        f(x) returns the value of f at x.

    f_prime : callable
        f_prime(x) returns the gradient of f.

    g_prox : callable of the form g_prox(x, alpha)
        g_prox(x, alpha) returns the proximal operator of g at x
        with parameter alpha.

    x0 : array-like
        Initial guess

    maxiter : int
        Maximum number of iterations.

    verbose : int
        Verbosity level, from 0 (no output) to 2 (output on each iteration)

    default_step_size : float
        Starting value for the line-search procedure.

    Returns
    -------
    res : OptimizeResult
        The optimization result represented as a
        ``scipy.optimize.OptimizeResult`` object. Important attributes are:
        ``x`` the solution array, ``success`` a Boolean flag indicating if
        the optimizer exited successfully and ``message`` which describes
        the cause of the termination. See `scipy.optimize.OptimizeResult`
        for a description of other attributes.
    """

Metadata

Release files for gdprox 0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gdprox 0.3
File Size Uploaded
gdprox-0.3.tar.gz 2.8 kB Details

Release files / gdprox-0.3.tar.gz

Download URL gdprox-0.3.tar.gz
Size 2.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7f077fd7c5f377c5aa34a0ec90cf1d7d2f7efe39e02061eb3b474130134498b4
BLAKE2b-256 checksum
How to use checksums
ae613bb674f1c63ee9bf3b27929c00bf4563d3a82c4b267ad3f4d117555f4d10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.3 This release

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page