AbstractTreeEstimator#

class gurobi_ml.modeling.decision_tree.decision_tree_model.AbstractTreeEstimator(gp_model, tree, input_vars, output_vars, epsilon, timer=None, **kwargs)#

Bases: AbstractPredictorConstr

Abstract class to model a decision tree

The decision tree should be stored in a dictionary with a similar representation as the one that scikit-learn uses:

“capacity”: number of nodes in the tree (size of the arrays that follow), “children_left”: index of left children (-1 for a leaf) “children_right”: index of right children (-1 for a leaf) “feature”: splitting feature of node “threshold”: threshold for spliting node “value”: value of the node for output variable

Attributes:

constrs: List of linear constraints added.
default_name: Default base name base used for automatic name generation.
genconstrs: List of general constraints added.
gp_model: Access gurobipy model this is a part of.
input: Input variables of embedded predictor.
input_values: Values for the input variables if a solution is known.
output: Output variables of embedded predictor.
output_values: Values for the output variables if a solution is known.
qconstrs: List of quadratic constraints added.
sos: List of SOS constraints added.
vars: List of variables added.

Methods

`get_error`(eps)	Functions returns an error for an abstract class
`print_stats`([abbrev, file])	Print statistics on model additions stored by this class.
`remove`()	Remove from gp_model everything that was added to embed predictor.

get_error(eps)#

Functions returns an error for an abstract class

Child classes should implement this.

print_stats(abbrev=False, file=None)#

Print statistics on model additions stored by this class.

This function prints detailed statistics on the variables and constraints that where added to the model.

Usually derived classes reimplement this function to provide more details about the structure of the additions (type of ML model, layers if it’s a neural network,…)

Parameters:: file (None, optional) – Text stream to which output should be redirected. By default sys.stdout.

remove()#: Remove from gp_model everything that was added to embed predictor.

property constrs#: List of linear constraints added.

property default_name#: Default base name base used for automatic name generation.

property genconstrs#: List of general constraints added.

property gp_model#: Access gurobipy model this is a part of.

property input#

Input variables of embedded predictor.

Returns:: output
Return type:: gurobipy MVar.

property input_values#

Values for the input variables if a solution is known.

Returns:: output_value
Return type:: ndarray or pandas dataframe with values
Raises:: NoSolution – If the Gurobi model has no solution (either was not optimized or is infeasible).

property output#

Output variables of embedded predictor.

Returns:: output
Return type:: gurobipy MVar.

property output_values#

Values for the output variables if a solution is known.

Returns:: output_value
Return type:: ndarray or pandas dataframe with values
Raises:: NoSolution – If the Gurobi model has no solution (either was not optimized or is infeasible).

property qconstrs#: List of quadratic constraints added.

property sos#: List of SOS constraints added.

property vars#: List of variables added.