Quickstart

This is a quickstart guide to get you up and running with the optymus project.

To begin using optymus, follow these steps:

1. Install the package via PyPI:

uv add optymus

2. Create an optimization problem:

from optymus import Optimizer
from optymus.benchmark import MccormickFunction

import jax.numpy as jnp

f = MccormickFunction()
initial_point = jnp.array([2, 2])

3. Optimize the problem:

opt = Optimizer(f_obj=f,
                x0=initial_point,
                method='bfgs')

4. Print the optimization report:

opt.report()