Opvious Python SDK
Project description
Opvious Python SDK
![Pypi badge](https://pypi-camo.freetls.fastly.net/dc506e98b1d565d7461b38a4af381a403b26c1de/68747470733a2f2f62616467652e667572792e696f2f70792f6f7076696f75732e737667)
This package provides a lightweight SDK for solving optimization models with the Opvious API. Its main features are:
- Seamless data import/export via native support for
pandas
- Powerful built-in debugging capabilities: automatic infeasibility relaxation, variable pinning, and more
- Non-blocking APIs for performant parallel calls
Quickstart
First, install this package and have an API access token handy (these can be generated here).
pip install opvious[aio] # aio is recommended for improved performance
With these steps out of the way, you are ready to solve any formulation:
import opvious
# Instantiate an API client from an API token
client = opvious.Client.from_token(TOKEN)
# Assemble and validate inputs for a registered formulation
inputs = await client.assemble_inputs(
formulation_name='my-formulation',
parameters={
# Formulation parameters...
}
)
# Start an attempt and wait for it to complete
attempt = await client.start_attempt(inputs)
# Wait for the attempt to complete
outcome = await client.wait_for_outcome(attempt)
Environments
Clients are compatible with Pyodide environments, for example JupyterLite
kernels. Simply install the package as usual in a notebook, omitting the aio
optional dependencies:
import piplite
await piplite.install('opvious')
In other environments, prefer using the aiohttp
-powered clients as they are
more performant (this is the default if the aio
dependencies were specified).
Next steps
This SDK is focused on solving optimization models. For convenient access to the rest of Opvious API's functionality, consider using the TypeScript SDK and CLI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.