Skip to main content

Intuitive symbolic interface for constrained optimization problems

Project description

Optyx

Optimization that reads like Python.

PyPI Python 3.12+ License: MIT CI Docs

📚 Documentation · 🚀 Quickstart · 💡 Examples

With Optyx With SciPy
from optyx import Variable, Problem

x = Variable("x", lb=0)
y = Variable("y", lb=0)

solution = (
    Problem()
    .minimize(x**2 + y**2)
    .subject_to(x + y >= 1)
    .solve()
)
# x=0.5, y=0.5
from scipy.optimize import minimize
import numpy as np

def objective(v):
    return v[0]**2 + v[1]**2

def gradient(v):  # manual!
    return np.array([2*v[0], 2*v[1]])

result = minimize(
    objective, x0=[1, 1], jac=gradient,
    method='SLSQP',
    bounds=[(0, None), (0, None)],
    constraints={'type': 'ineq',
                 'fun': lambda v: v[0]+v[1]-1}
)

Your optimization code should read like your math. With Optyx, x + y >= 1 is exactly that—not a lambda buried in a constraint dictionary.


Why Optyx?

Python has excellent optimization libraries. SciPy provides algorithms. CVXPY handles convex problems. Pyomo scales to industrial applications.

Optyx takes a different path: radical simplicity.

  • Write problems as you think themx**2 + y**2 not lambda v: v[0]**2 + v[1]**2
  • Never compute gradients by hand — symbolic autodiff handles derivatives
  • Skip solver configuration — sensible defaults, automatic solver selection

Being Honest

Optyx is young and opinionated. It's not a replacement for specialized tools:

Need Use Instead
MILP at scale Pyomo, OR-Tools, Gurobi
Convex guarantees CVXPY
Maximum performance Raw solver APIs

But if you want readable optimization code that just works for most problems, Optyx might be for you.


Installation

pip install optyx

Requires Python 3.12+, NumPy ≥2.0, SciPy ≥1.6.


Quick Examples

Constrained Quadratic

from optyx import Variable, Problem

x = Variable("x", lb=0)
y = Variable("y", lb=0)

solution = (
    Problem()
    .minimize(x**2 + y**2)
    .subject_to(x + y >= 1)
    .solve()
)
# x=0.5, y=0.5, objective=0.5

Portfolio Optimization

from optyx import Variable, Problem

# Asset weights
tech = Variable("tech", lb=0, ub=1)
energy = Variable("energy", lb=0, ub=1)
finance = Variable("finance", lb=0, ub=1)

# Expected returns and risk (simplified)
returns = 0.12*tech + 0.08*energy + 0.10*finance
risk = tech**2 + energy**2 + finance**2  # variance proxy

solution = (
    Problem()
    .minimize(risk)
    .subject_to(returns >= 0.09)              # minimum return
    .subject_to((tech + energy + finance).eq(1))  # fully invested
    .solve()
)

Autodiff Just Works

from optyx import Variable
from optyx.core.autodiff import gradient

x = Variable("x")
f = x**3 + 2*x**2 - 5*x + 3

df = gradient(f, x)  # Symbolic: 3x² + 4x - 5
print(df.evaluate({"x": 2.0}))  # 15.0

Features at a Glance

Feature Description
Natural syntax x + y >= 1 instead of constraint dictionaries
Automatic gradients Symbolic differentiation—no manual derivatives
Smart solver selection HiGHS for LP, SLSQP/BFGS for NLP
Fast re-solve Cached compilation, up to 900x speedup
Debuggable Inspect expression trees, understand your model

See the documentation for the full API reference, tutorials, and real-world examples.


What's Next

Optyx is actively evolving:

  • Vector/Matrix variables — Handle thousands of decision variables cleanly
  • JIT compilation — Faster execution for complex models
  • More solvers — IPOPT integration for large-scale NLP
  • Better debugging — Infeasibility diagnostics and model inspection

See the roadmap for details.


Contributing

git clone https://github.com/daggbt/optyx.git
cd optyx
uv sync
uv run pytest

Contributions welcome! See our contributing guide.


License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optyx-1.2.4.tar.gz (77.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

optyx-1.2.4-py3-none-any.whl (87.2 kB view details)

Uploaded Python 3

File details

Details for the file optyx-1.2.4.tar.gz.

File metadata

  • Download URL: optyx-1.2.4.tar.gz
  • Upload date:
  • Size: 77.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for optyx-1.2.4.tar.gz
Algorithm Hash digest
SHA256 d887543070d3ec539292c4ab74065dcc6ef322da43bbe2a5b66cd69429b0d0b8
MD5 1ebadc41309051ca490e5215bd3823da
BLAKE2b-256 6dc25744f9b91e5aa4f8e202c97639a4eb6ce1be444f53349e43b59436a54b7e

See more details on using hashes here.

File details

Details for the file optyx-1.2.4-py3-none-any.whl.

File metadata

  • Download URL: optyx-1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 87.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for optyx-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b2fdf5c32982d7f54f8acd72854b985ad791b6cb834db13d055098fdf2197b9f
MD5 ecb52abdf7d331d9f0a8e11d5af1c9a6
BLAKE2b-256 041635c914e4e640a94ebd80016f518ee4f7e375accfbc8284506c40047cefce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page