QpiAI Opt SDK

QpiAI Opt is a Python SDK for mathematical optimization, with algebraic modelling, local solvers, QpiAI Platform execution, and standard model interchange. Its native higher-order HUBO solver evaluates higher-order interactions directly, preserving the polynomial's original energy landscape without quadratization or reduction-induced approximations. Gate-based optimization is available with access to QpiAI simulators and QPUs.

The modelling SDK is open source under Apache-2.0; the local solver runtime is distributed as a native binary. Python 3.10–3.14 is supported on Linux, macOS, and Windows.

Docs: QpiAI Opt SDK Documentation.

Install

Install:

python -m pip install qpiai-opt

The distribution name is qpiai-opt; the import namespace is qpiai_opt. The base package includes the QpiAI Opt local solver and supports local LP, MILP, QP, QUBO, HUBO, and Ising solving. Install an extra only for its integration:

python -m pip install "qpiai-opt[quantum]"
python -m pip install "qpiai-opt[ommx]"
python -m pip install "qpiai-opt[all]"

quantum installs qpiai-quantum==0.3.0, ommx adds OMMX interchange, and all installs both. See gate-based optimization and OMMX interchange for requirements and usage.

Read the user manual in order for installation, modelling, solving, interoperability, automation, and complete API reference.

First local solve

Local solving through an Opt Client verifies the Opt key online before computation; disconnected or unverifiable authentication stops execution. Register for a free Opt API key at QpiAI Opt and place it in your application's secret store. The code below reads it from the QPIAI_OPT_API_KEY environment variable.

import os

from qpiai_opt.opt_modeller import Binary, Model
from qpiai_opt.opt_solvers import Client, solve

client = Client(api_key=os.environ["QPIAI_OPT_API_KEY"])

x = Binary("x")
y = Binary("y")

model = Model("selection")
model.maximize(6 * x + 4 * y)
model.add_constraint(x + y <= 1, label="capacity")

result = solve(model, client=client)  # mode="local" is the default
print(result.problem_class)  # "MILP"
print(result.execution_mode)  # "local"
print(result.solution)  # {"x": 1.0, "y": 0.0}
print(result.objective)  # source objective, including MAX sense

solve() accepts a Model, QUBOProblem, HUBOProblem, IsingProblem, MILPProblem, an LP/MPS path (plain or gzip), or the documented linear/polynomial dictionaries. It returns the same problem-class-specific result shape in local and platform modes.

Numeric inputs use IEEE-754 binary64 semantics. Ordinary decimal-to-binary rounding is expected; the SDK does not provide arbitrary-precision decimal arithmetic. Keep values within the finite binary64 range and scale a model whose coefficients or bounds are extremely large or small. An integer larger than 2**53 may not retain every digit when converted to binary64, so use smaller or scaled values where exact integer meaning matters. Decimal values are not accepted as numeric inputs; use a supported Python or NumPy real value instead. The detailed numeric rules are in the canonical IR reference.

Execution scope

Registration, API-key issuance, and local solving are free. Local solving through an Opt Client verifies the supplied Opt key online before computation; disconnected or unverifiable authentication stops execution. No optimization model is sent to the authentication endpoint. Gate-based optimization on local simulators and QpiAI simulators and QPUs requires an active QpiAIQuantumAuth.login(QCLOUD_API_KEY) and fresh QCloud verification. Obtain a free QCloud API key at QpiAI QCloud. Modelling, validation, inspection, conversion, and result evaluation remain credential-free.

Selecting platform execution with an authenticated Client authorizes the submission and any associated credit use.

In auto mode, platform fallback requires allow_platform=True and occurs only after LocalLimitExceeded. Authentication errors propagate. The limit exception includes observed, limits, explanation, and next_action. Job creation has no idempotency key; after an ambiguous submission timeout, list existing jobs before retrying.

See Local solving and routing for accepted inputs, limits, options, statuses, and failure recovery.

Modelling and representations

The algebraic modeller supports:

• continuous, integer, binary, spin, semi-continuous, semi-integer, fixed-point fractional, and mixed domains;
• linear relations, indicators, SOS1/SOS2, binary logic, and custom penalties;
• constrained QUBO and HUBO compilation with source-sample decoding;
• native Ising fields and couplings;
• LP/MPS/gzip, sparse matrix, QUBO/HUBO dictionaries, and canonical JSON IR;
• explicit QUBO↔Ising, HUBO→QUBO, QUBO→MILP, and MILP→QUBO conversions;
• multidimensional IndexedVariables and bound/coefficient/RHS parameters;
• convex continuous QP with a documented Hessian convention;
• exact SOS2 piecewise-linear relationships and inspectable transformations;
• QAOA, VQE, SamplingVQE, RecursiveQAOA, and ADAPT-QAOA execution through qpiai-quantum circuits, simulation, and QpiAI simulators and QPUs access;
• optional OMMX import/export for supported model structures.

Reference guides:

• MILP modeller
• Continuous QP modeller
• QUBO modeller
• HUBO modeller
• Ising modeller
• Indexed variables, parameters, and updates
• Canonical IR
• Gate-based optimization and gate-based optimization API
• External interoperability
• Piecewise-linear modelling
• Transformation inspection

Explicit platform execution

Read the credential from your application's environment or secret manager. This call explicitly requests paid platform execution:

import os

from qpiai_opt.opt_solvers import Client, solve

API_KEY = os.environ["QPIAI_OPT_API_KEY"]

client = Client(api_key=API_KEY)
result = solve(model, mode="platform", client=client)
print(result.model_dump(mode="json"))

The default endpoint is https://opt-server.qpiai.tech/api. Platform mode creates a problem and job and can consume credits. For nonblocking control use the automation submit(), status(), result(), and cancel() operations, or a solver instance's nonblocking methods.

The platform client reference covers account, organization, membership, workspace, project, experiment, problem, job, credit usage and allocations, compute-resource, storage, SSE, and retry behavior. Solver-specific request and response fields are in:

• QUBO solver
• HUBO solver
• MILP solver

Automation-safe Python API

from qpiai_opt.opt_solvers import (
    classify,
    feasibility,
    inspect,
    provider_capabilities,
    schemas,
)

print(classify(model))
print(inspect(model))
print(provider_capabilities())
print(feasibility(model, {"x": 1, "y": 0}))
print(schemas()["solve_result"])

These functions return strings, dictionaries, or lists for programmatic use. See Automation and agent workflows for workflow procedures and request schemas.

Result contract

Results include the problem class, execution mode, identifiers, source objective, and solver_time_s/compute_time_s in seconds. result.info() reports the method, termination, feasibility, and optimality guarantee.

info = result.info()
print(info.method, info.termination, info.guarantee)

The solve_info field stores execution details in serialized results; info() returns a detached view. Platform job status describes execution progress, while solve information describes the mathematical outcome. Serialize results with model_dump(mode="json"). See the completed result contract for fields, runtime units, statuses, and source-variable interpretation.

Development and releases

Source and development are hosted at qpiai/qpiai-opt. See CONTRIBUTING.md for development setup, documentation builds, release checks, and community guidelines.

Use the bug reporting guide for reproducible defects, the feature request guide for proposals, and private vulnerability reporting for security issues. The package is licensed under the Apache License 2.0; third-party notices identify incorporated components and their licenses.

We follow Semantic Versioning (SemVer).

Citation

When QpiAI Opt materially supports published work, cite the exact version. Repository hosts can read the structured CITATION.cff metadata. Plain-text citation:

QpiAI. QpiAI Opt SDK, version 0.0.9, 2026. https://github.com/qpiai/qpiai-opt

BibTeX:

@software{qpiai_opt_0_0_9,
  author  = {{QpiAI}},
  title   = {QpiAI Opt SDK},
  version = {0.0.9},
  year    = {2026},
  url     = {https://github.com/qpiai/qpiai-opt}
}