tabular_trees.MonotonicConstraintResults

class tabular_trees.MonotonicConstraintResults(summary, constraints, results)

Bases: object

Results of checking monotonic constraints.

__init__(summary, constraints, results)

Initialise the MonotonicConstraintResults object.

Parameters:

• summary (dict[str, bool]) – Summary of whether monotonic constraints are met. Keys give variable names and values indicate if the constraint is met.

• constraints (dict[str, int]) – Monotonic constraints. Keys give variable names and values define the constraints. A value of 1 is a monotonically increasing constraint and a value of -1 is a monotonically decreasing constraint.

• results (pd.DataFrame) – Detailed breakdown of whether constraints are met at split level in trees.

Methods

__init__(summary, constraints, results)

Initialise the MonotonicConstraintResults object.

Attributes

summary	Summary of whether monotonic constraints are met.
constraints	Monotonic constraints.
results	Detailed breakdown of whether constraints are met at split level in trees.
all_constraints_met	Are all of the monotonic constraints met.

all_constraints_met

Are all of the monotonic constraints met.

constraints

Monotonic constraints.

results

Detailed breakdown of whether constraints are met at split level in trees.

summary

Summary of whether monotonic constraints are met.