ncOPT
This repository is for solving constrained optimization problems where objective and/or constraint functions are (arbitrary) PyTorch modules. It is mainly intended for optimization with pre-trained networks, but might be useful also in other contexts.
Short Description
The algorithms in this package can solve problems of the form
min f(x)
s.t. g(x) <= 0
h(x) = 0
where f, g and h are locally Lipschitz functions.
Key functionalities of the package:
- forward and backward pass of functions can be done on GPU
- batched evaluation and Jacobian computation using PyTorch's
autograd; no gradient implementation needed - support for inequality and equality constraints; constraints can use only a subset of the optimization variable as input
Table of contents
Disclaimer
- We have not (yet) extensively tested the solver on large-scale problems.
- The implemented solver is designed for nonsmooth, nonconvex problems, and as such, can solve a very general problem class. If your problem has a specific structure (e.g. convexity), then you will almost certainly get better performance by using software/solvers that are specifically written for the respective problem type. As starting point, check out
cvxpy. - The solver is not guaranteed to converge to a (global) solution (see the theoretical results in [1] for convergence to local solutions under certain assumptions).
Installation
The package is available from PyPi with
python -m pip install ncopt
Alternatively, for an editable version of this package in your Python environment, clone this repository and run the command
python -m pip install --editable .
Getting started
Solver interface
The main solver implemented in this package is called SQP-GS, and has been developed by Curtis and Overton in [1]. See the detailed documentation.
The SQP-GS solver can be called via
from ncopt.sqpgs import SQPGS
problem = SQPGS(f, gI, gE)
problem.solve()
Here f is the objective function, and gI and gE are a list of inequality and equality constraints. An empty list can be passed if no (in)equality constraints are needed.
The ObjectiveOrConstraint class
The objective f and each element of gI and gE should be passed as an instance of ncopt.functions.ObjectiveOrConstraint (a simple wrapper around a torch.nn.Module).
- Each constraint function is allowed to have multi-dimensional output (see example below).
- IMPORTANT: For the objective, we further need to specify the dimension of the optimization variable with the argument
dim. For each constraint, we need to specify the output dimension withdim_out.
For example, a linear constraint function Ax - b <= 0 can be implemented as follows:
from ncopt.functions import ObjectiveOrConstraint
A = .. # your data
b = .. # your data
g = ObjectiveOrConstraint(torch.nn.Linear(2, 2), dim_out=2)
g.model.weight.data = A # pass A
g.model.bias.data = -b # pass b
Functionalities
Let's assume we have a torch.nn.Module, call it model, which we want to use as objective/constraint. For the solver, we can pass the function as
f = ObjectiveOrConstraint(model)
-
Dimension handling: Each function must be designed for batched evaluation (that is, the first dimension of the input is the batch size). Also, the output shape of
modelmust be two-dimensional, that is(batch_size, dim_out), wheredim_outis the output dimension for a constraint, anddim_out=1for the objective. -
Device handling: The forward pass, and Jacobian calculation is done on the device on which the parameters of your model. For example, you can use
model.to(device)before creatingf. See this Colab example how to use a GPU. -
Input preparation: Different constraints might only need a part of the optimization variable as input, or might require additional preparation such as reshaping from vector to image. (Note that the optimization variable is handled always as vector). For this, you can specify a callable
prepare_inputwhen initializing aObjectiveOrConstraintobject. Any reshaping or cropping etc. can be handled with this function. Please note thatprepare_inputshould be compatible with batched forward passes.
Examples
2D Nonsmooth Rosenbrock
This example is taken from Example 5.1 in [1] and involves minimizing a nonsmooth Rosenbrock function, constrained with a maximum function. The picture below shows the trajectory of the SQP-GS solver for different starting points. The final iterates are marked with the black plus while the analytical solution is marked with the golden star. We can see that the algorithm finds the minimizer consistently.
Sparse signal recovery
This example is taken from Example 5.3 in [1]. We minimize the q-norm $||x||_q$ under the constraint of approximate signal recovery $||Rx-y|| \leq \delta$. Here $R$ comes from the Discrete Cosine Transform.
When $q\geq 1$ the problem is convex and rather easy to solve. For $q<1$, we observed that the number of sample points need to be increased a lot in order to make the subproblems solvable in reasonable time.
This problem has dimension 256, with one scalar constraint. To give a feeling for runtime, below is the runtime per iteration (for $q=1$), split into the main parts: sample points and compute gradients (sample_and_grad), solve the quadratic subproblem (subproblem), do the update step of iterate and approximate Hessian (step), and all other routines.
Pretrained neural network constraint
This toy example illustrates how to use a pretrained neural network as constraint function in ncOPT. We train a simple model to learn the mapping $(x_1,x_2) \mapsto \max(\sqrt{2}x_1, 2x_2) -1$. Then, we load the model checkpoint to use it as constraint.
Below we show the feasible set (in blue), and the final iterate, if we use as objective the squared distance to the vector of ones.
References
[1] Frank E. Curtis and Michael L. Overton, A sequential quadratic programming algorithm for nonconvex, nonsmooth constrained optimization, SIAM Journal on Optimization 2012 22:2, 474-500, https://doi.org/10.1137/090780201.
Metadata
Release files for ncopt 0.2.0
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 |
|---|---|---|---|---|
| ncopt-0.2.0.tar.gz | 242.0 kB | Without provenance | Details for ncopt-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ncopt-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for ncopt-0.2.0-py3-none-any.whl |
Total release size: 268.5 kB
Release files / ncopt-0.2.0.tar.gz
| Download URL | ncopt-0.2.0.tar.gz |
|---|---|
| Size | 242.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
24b13df27249276804289eaf9c6329f2eda5b411e243022b1c1f22cc8f9bb175
|
|
BLAKE2b-256 checksum How to use checksums |
10d7522732ab1903309b7cd4865fd358674265efc7c47b22cc3187c671266e2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
Release files / ncopt-0.2.0-py3-none-any.whl
| Download URL | ncopt-0.2.0-py3-none-any.whl |
|---|---|
| Size | 26.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
01fed1ddc2b1dcc26f61dcbc8e9550ca5fc37bb087aaf6ebafd8ac64575a80f7
|
|
BLAKE2b-256 checksum How to use checksums |
16120077c94a2b08b5821ab132b303fa90bb3d07a4f0de6db3ce2926faae803f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
Security for ncopt 0.2.0
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
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.