Overview of Pyoframe's API

Pyoframe's classes and subclasses are structured as follows:

• Model
• BaseBlock*
  • Constraint
  • BaseOperableBlock*
    • Variable
    • Expression
      • Objective
    • Set
• Config

The following enums are also available:

• VType
• ObjSense

Finally, PyoframeError is a Pyoframe custom error type.

All the above classes (except those marked with an asterisk) can be imported via:

import pyoframe as pf

Additionally, importing Pyoframe patches Pandas and Polars such that calling for df.to_expr() is equivalent to pf.Param(df). This also works for pandas Series.

Comments