col_gen_estimator API

This is an example on how to document the API of your own project.

Estimator

BooleanDecisionRuleClassifier([...])	Binary classifier using boolean decision rule generation method.
BooleanDecisionRuleClassifierWithHeuristic([...])	Binary classifier using boolean decision rule generation method with heuristic for column generation.
DTreeClassifier([initial_paths, leaves, ...])	Decision Tree classifier using column generation.

Master Problems

BDRMasterProblem([C, p, solver_str])	The master problem for boolean decision rule generation described in 'Boolean decision rules via column generation' by Sanjeeb Dash et.
DTreeMasterProblem(initial_paths, leaves, ...)	Master problem for Decision Tree classifier.

Subproblems and heuristics

BDRSubProblem(D[, solver_str])	The subproblem for boolean decision rule generation described in 'Boolean decision rules via column generation' by Sanjeeb Dash et.
BDRHeuristic(K)	Heuristically generates the new columns to be added to the RMP.
DTreeSubProblem(leaf, nodes, splits, ...[, ...])	TODO: Documentation.
DTreeSubProblemHeuristic(leaves, nodes, ...)	TODO: Documentation.

Other Classes

Row()	To make the processing faster, we store some row related information in this class.
Path()	All path related information.
Node()	All node related information.
Leaf()	All leaf related information.
Split()	All split related information.