Python API Reference#

This section documents the Gurobi Python interface. It begins with anoverview of the global functions, which can be calledwithout referencing any Python objects. It then discusses the different types ofobjects that are available in the interface, and the most important methods onthose objects. Finally, it gives a comprehensive presentation of all of theavailable classes and methods.

If you are new to the Gurobi Optimizer, we suggest that you start with theGetting Started Knowledge Base article for general information. This alsoincludesTutorials for the different Gurobi APIs. Additionally, ourExample Tour provides concrete examples of howto use the classes and methods described here. We will point to sections orexamples of this tour whenever it fits in this overview.

In the Python examples in this documentation, we assume that your code startswith an import statementimportgurobipyasgp so that global functions andtypes can be accessed through thegp. prefix. We also assume that the importstatementfromgurobipyimportGRB is used so that all constants in theGRB class are directly accessible (e.g. asGRB.MINIMIZE).

The Gurobi Python interface is delivered in its own packages and is installedseparately from the rest of the solver. You will find instructions on how toinstall it in theGurobi Python API installation guide.

Contents