Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

fastprox

Fast, exact proximal operators and projections, with derivatives.

fastprox computes proxγg(x) = argminz g(z) + ‖z − x‖² / (2γ) for over thirty functions g used in optimisation, signal and image processing and statistics, along any axis of a batch of arrays. It also differentiates them: Jacobian-vector and vector-Jacobian products in the input, the step γ and the function's own parameters. The core is C++17 behind a plain-C API, with Python bindings, PyTorch and JAX wrappers, and image TV that runs on GPUs.

Why fastprox

  • Exact where an exact algorithm exists, certified where it doesn't. 1D TV, the simplex and ℓ1 ball, isotonic regression, graph TV and tree TV are solved exactly. The image TV solvers stop on a duality gap, which bounds the error of the result, and anisotropic TV is then polished to the exact solution.
  • Derivatives without unrolling. Every operator has a JVP and a VJP, exact or by implicit differentiation on the solution's structure, so the backward pass of an iterative solver costs one linear solve and constant memory, not autograd through its iterations. At kinks, where the prox is not differentiable, the library can tell you which points sit there and differentiate either side.
  • Fast. Measured in docs/benchmarks.md:
    • 1D TV and simplex projection run as fast as proxTV and Condat's reference C code, or faster (1D TV in about 6–15 ns per sample).
    • Anisotropic TV reaches an error of 1e-6 about 3× faster than the best proxTV solver on 256² and 512² images.
    • Isotropic TV against DeepInverse's TVDenoiser on an NVIDIA T4: 7.5× faster to an error of 1e-2, and at the same gradient accuracy a backward pass of 281 ms with 6 MiB kept, against 1002 ms and 4 GiB through 400 unrolled iterations.
    • Graph TV on large grids is up to 2.7× faster in 0.4, on a new max-flow engine (EIBFS).
  • Batched and deterministic. float32 or float64, along any axis, with rows processed in parallel on fastprox's own thread pool (no OpenMP runtime to clash with PyTorch's). Results are bit-identical for any number of threads.
  • Light and permissive. The wheels depend only on NumPy. MIT licensed, and every kernel is written from the published papers.

Install

pip install fastprox

The 1.0 release candidate, whose C ABI holds for every 1.x: pip install --pre fastprox.

Wheels are abi3 for CPython 3.12 and later on Linux (x86_64, aarch64), macOS (arm64 from 11.0, x86_64 from 10.15) and Windows (amd64). The PyTorch and JAX wrappers use PyTorch and JAX when they are installed, and never require them.

Quick start

One-shot functions apply an operator along the last axis by default:

import numpy as np
import fastprox as fp

x = np.random.default_rng(0).normal(size=(64, 1000))

z = fp.tv1d(x, gamma=0.5)                  # 1D total variation, row by row
p = fp.project_simplex(x, radius=1.0)      # each row onto the simplex
s = fp.soft_threshold(x, lam=0.1)

Operators keep what the derivatives need:

op = fp.TV1D(weights=0.8)
z, ctx = op.prox(x, 0.5, keep=True)
dz = op.jvp(ctx, dx=np.ones_like(x))       # Jacobian-vector product
gx, grads = op.vjp(ctx, g=z - x)           # vector-Jacobian product
print(grads.gamma, grads.weights)          # gradients in the step and the weights

Images are batched over the leading axes; the result comes with its certificate:

images = np.random.default_rng(1).normal(size=(8, 256, 256))
z, info = fp.tv_iso(images, gamma=0.1, tol=1e-6)    # isotropic TV of each image
print(info.gap, info.iters)                         # duality gap reached, iterations

PyTorch and JAX. Image TV runs on the tensor's own device (CUDA, MPS or the CPU), and gradients come from implicit differentiation:

import torch
import fastprox.torch as fpt

x = noisy.cuda().requires_grad_()               # (batch, channels, H, W)
gamma = torch.tensor(0.1, device="cuda", requires_grad=True)
z = fpt.tv_iso(x, gamma, tol=1e-6)              # TV over the last two axes
((z - clean.cuda()) ** 2).mean().backward()     # x.grad and gamma.grad

w = torch.full((999,), 0.8, dtype=torch.float64, requires_grad=True)
y = fpt.prox(fp.TV1D, torch.randn(64, 1000, dtype=torch.float64), 0.5, weights=w)

fastprox.jax has the same functions, under jit, grad and vmap.

Operators

Family Operators
Elementwise soft thresholding (weighted), elastic net, Huber, box, nonnegative orthant, log barrier, ℓ1 over a box
Nonconvex ℓ0, ℓq (0 < q < 1), SCAD and MCP (weighted), log penalty, with an explicit rule at ties
Groups and trees group ℓ2, group Huber, group SCAD and MCP, tree-structured group norms, sparse group lasso
Projections ℓ2 ball, simplex, weighted ℓ1 ball, hyperplane or half-space intersected with a box, second-order cone; also the ℓ∞ norm, max and the sum of the k largest entries
Signals isotonic regression, 1D TV with per-edge weights, its ℓ2-of-differences variant, projection onto a 1D TV ball
Images anisotropic and isotropic TV in 2D and 3D, with per-axis and per-pixel weights and warm starts; on GPUs through PyTorch and JAX
Graphs TV on any graph, exact, by parametric max-flow; TV on trees and paths by dynamic programming

Every operator also has its conjugate prox, through the Moreau identity. The operators with kinks report which entries sit at one, and differentiate either side of it on request: the thresholding and nonconvex maps, the box and orthant, the simplex and ℓ1 ball, group ℓ2, and 1D, image, graph and tree TV (for graph and tree TV the kinks are edges; isotropic TV reports them but has one side only).

Documentation

The documentation site is at https://dvillacis.github.io/fastprox/; its pages are also in the repository:

C library

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build && cmake --install build --prefix /usr/local

Then find_package(fastprox) and link fastprox::fastprox, or use pkg-config --cflags --libs fastprox. Everything is in one header, include/fastprox.h:

#include <fastprox.h>

double x[1000], z[1000];                      /* filled by the caller */
const int64_t shape[1] = {1000};
fp_array xa = {x, FP_F64, 1, shape, NULL, FP_DEVICE_CPU};  /* NULL strides: C order */
fp_array za = {z, FP_F64, 1, shape, NULL, FP_DEVICE_CPU};

fp_op *op;
fp_status s = fp_op_tv1d(NULL, FP_TV1D_AUTO, &op);        /* unit edge weights */
if (s == FP_OK) {
    s = fp_prox(op, 0.5, &xa, &za, NULL, NULL, NULL);    /* default options */
    fp_op_free(op);
}
if (s != FP_OK) fprintf(stderr, "fastprox: %s\n", fp_strerror(s));

License

MIT

Metadata

Release files for fastprox 1.0.0rc1

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

Source distribution (sdist)

Source distribution for fastprox 1.0.0rc1
File Size Uploaded Provenance Actions
fastprox-1.0.0rc1.tar.gz 1.0 MB With provenance Details for fastprox-1.0.0rc1.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for fastprox 1.0.0rc1
File Actions
fastprox-1.0.0rc1-cp312-abi3-win_amd64.whl CPython 3.12 abi3 Windows x86-64 Details for fastprox-1.0.0rc1-cp312-abi3-win_amd64.whl
fastprox-1.0.0rc1-cp312-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl CPython 3.12 abi3 Linux glibc 2.26+ x86-64, Linux glibc 2.28+ x86-64 Details for fastprox-1.0.0rc1-cp312-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl
fastprox-1.0.0rc1-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl CPython 3.12 abi3 Linux glibc 2.28+ ARM64, Linux glibc 2.26+ ARM64 Details for fastprox-1.0.0rc1-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
fastprox-1.0.0rc1-cp312-abi3-macosx_11_0_arm64.whl CPython 3.12 abi3 macOS 11.0+ ARM64 Details for fastprox-1.0.0rc1-cp312-abi3-macosx_11_0_arm64.whl
fastprox-1.0.0rc1-cp312-abi3-macosx_10_15_x86_64.whl CPython 3.12 abi3 macOS 10.15+ x86-64 Details for fastprox-1.0.0rc1-cp312-abi3-macosx_10_15_x86_64.whl

Total release size: 3.8 MB

Release files / fastprox-1.0.0rc1.tar.gz

Download URL fastprox-1.0.0rc1.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
9b448eb8e1856776e56cb277e051167f7a4cad6cd0ebb1234bcce5fc2e940e8d
BLAKE2b-256 checksum
How to use checksums
4982b6127f197ad12090cf7edf2e67acad70d20a3b909a25e2c2caa27381cb97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / fastprox-1.0.0rc1-cp312-abi3-win_amd64.whl

Download URL fastprox-1.0.0rc1-cp312-abi3-win_amd64.whl
Size 589.6 kB
Tags CPython 3.12 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
f1c6dea6dc7daeca10832a4dbedb16e727bf3c7cacff19d215043d8ad10d3033
BLAKE2b-256 checksum
How to use checksums
fbc52fb227f400caad784746e4a730980a5575d3f83275d72e9283ca260512ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / fastprox-1.0.0rc1-cp312-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl

Download URL fastprox-1.0.0rc1-cp312-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl
Size 680.3 kB
Tags CPython 3.12 Linux glibc 2.26+ x86-64 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
72dfb22ab9032ddf425fb9f3dc1f35201b3af2e03d37f084c80c564f5222061d
BLAKE2b-256 checksum
How to use checksums
e4a0cc2e14f5d967eb2b6634364b080d38c4336b21c566d48a05700d40a33fda
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / fastprox-1.0.0rc1-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl

Download URL fastprox-1.0.0rc1-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
Size 610.8 kB
Tags CPython 3.12 Linux glibc 2.26+ ARM64 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
892004a9b6ce9f437e55a6923e90073a0ac84de17eeefe88208a5cc59346e900
BLAKE2b-256 checksum
How to use checksums
d4b8a9360f832ff8ce036959bc1d121dd144645011a1417f93ab9a7020a9e9be
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / fastprox-1.0.0rc1-cp312-abi3-macosx_11_0_arm64.whl

Download URL fastprox-1.0.0rc1-cp312-abi3-macosx_11_0_arm64.whl
Size 366.0 kB
Tags CPython 3.12 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
5af272ef599d647713d6415ba10e6f31c58442e2ac77da80bb8c6a317401c4f1
BLAKE2b-256 checksum
How to use checksums
023fc2c9f3d926a67b2716a1127da0828fc925f79bd8f3ad8c6ab4df83a83339
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / fastprox-1.0.0rc1-cp312-abi3-macosx_10_15_x86_64.whl

Download URL fastprox-1.0.0rc1-cp312-abi3-macosx_10_15_x86_64.whl
Size 469.3 kB
Tags CPython 3.12 abi3 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
b2f31835a61497526517fdc347d77806f6e4e8b251e182de4576b5e0c833e249
BLAKE2b-256 checksum
How to use checksums
04ca80c1ee3efe48c76c9c066296d777dc14ac3b16d82bbfac8eab600befb043
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for fastprox 1.0.0rc1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for fastprox-1.0.0rc1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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