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
TVDenoiseron 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
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:
- API reference, for C and Python
- Examples: 1D and image denoising, proximal gradient, sparse recovery, group sparsity, the weighted graphical lasso, derivatives, bilevel learning, reweighted TV, PyTorch and JAX
- Benchmarks against proxTV, Condat's C code and DeepInverse
- Using fastprox in place of DeepInverse's TV denoisers
- Design specification, roadmap and changelog
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 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fastprox-0.5.1.tar.gz | 1.0 MB | With provenance | Details for fastprox-0.5.1.tar.gz |
Built distributions (wheels)
| File | Actions Reset | |||
|---|---|---|---|---|
| fastprox-0.5.1-cp312-abi3-win_amd64.whl | CPython 3.12 | abi3 | Windows x86-64 | Details for fastprox-0.5.1-cp312-abi3-win_amd64.whl |
| fastprox-0.5.1-cp312-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl | CPython 3.12 | abi3 | Linux glibc 2.28+ x86-64, Linux glibc 2.26+ x86-64 | Details for fastprox-0.5.1-cp312-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl |
| fastprox-0.5.1-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-0.5.1-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl |
| fastprox-0.5.1-cp312-abi3-macosx_11_0_arm64.whl | CPython 3.12 | abi3 | macOS 11.0+ ARM64 | Details for fastprox-0.5.1-cp312-abi3-macosx_11_0_arm64.whl |
| fastprox-0.5.1-cp312-abi3-macosx_10_15_x86_64.whl | CPython 3.12 | abi3 | macOS 10.15+ x86-64 | Details for fastprox-0.5.1-cp312-abi3-macosx_10_15_x86_64.whl |
Total release size: 3.8 MB
Release files / fastprox-0.5.1.tar.gz
| Download URL | fastprox-0.5.1.tar.gz |
|---|---|
| Size | 1.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f4a56f67db064eafdf0db1a59aefddb7cfa0fb658097070516873b9d6eafd121
|
|
BLAKE2b-256 checksum How to use checksums |
d76194f9a3944c331ae7515e9af25e7de15ca069eaa68377ea2d3023e0a839d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 21, 2026.
Transparency logRelease files / fastprox-0.5.1-cp312-abi3-win_amd64.whl
| Download URL | fastprox-0.5.1-cp312-abi3-win_amd64.whl |
|---|---|
| Size | 591.2 kB |
| Tags | CPython 3.12 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
9a978abb2227822f05b6a45318f0e8a9322b2abb0b329a8cdc46446c51f67795
|
|
BLAKE2b-256 checksum How to use checksums |
0bffeaad723a5dba9d4837fb67e2508c771107a7c7140b1e551f24fb7635fe87
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 21, 2026.
Transparency logRelease files / fastprox-0.5.1-cp312-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl
| Download URL | fastprox-0.5.1-cp312-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 683.4 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 |
33b5c694327cffe4c57f6648855b1a8fcaede57d9d99a53f072bbf88610a0865
|
|
BLAKE2b-256 checksum How to use checksums |
de96013b7c0c586dda4caba7d39d90f353c77dbb2a7af6048ea8c857b2cc1a64
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 21, 2026.
Transparency logRelease files / fastprox-0.5.1-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
| Download URL | fastprox-0.5.1-cp312-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl |
|---|---|
| Size | 612.7 kB |
| Tags | CPython 3.12 Linux glibc 2.26+ ARM64 Linux glibc 2.28+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
6d6f14ccbfe306f6c922314a0ea4c8de9281b42262054714a5adec0d0b6a1505
|
|
BLAKE2b-256 checksum How to use checksums |
f35aaf65712cf5c0ebc837ad25409b3eed6309a2a3a40c660cdcdcfe7c9b7808
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 21, 2026.
Transparency logRelease files / fastprox-0.5.1-cp312-abi3-macosx_11_0_arm64.whl
| Download URL | fastprox-0.5.1-cp312-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 366.3 kB |
| Tags | CPython 3.12 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
73d191218beedf5dfed442e2eba5e81744c09ea136ac7c57f734be759ffc4ab4
|
|
BLAKE2b-256 checksum How to use checksums |
5ac2e796330191fd80cb345e684e15decee662319424096e3660df9537ad4b2d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 21, 2026.
Transparency logRelease files / fastprox-0.5.1-cp312-abi3-macosx_10_15_x86_64.whl
| Download URL | fastprox-0.5.1-cp312-abi3-macosx_10_15_x86_64.whl |
|---|---|
| Size | 471.1 kB |
| Tags | CPython 3.12 abi3 macOS 10.15+ x86-64 |
|
SHA-256 checksum How to use checksums |
268af3319fffe16cfbc6c0ec348963a5331bca004833c4274c12f61e7e8f4acb
|
|
BLAKE2b-256 checksum How to use checksums |
470fe3ba123e802a3d2f8d64286f40a64f465b03a949db844512f2a08511cf1e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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 21, 2026.
Transparency logSecurity for fastprox 0.5.1
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.
Attestation for fastprox-0.5.1.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 21, 2026.
Transparency logA 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.