holisticai.explainability.metrics.tree_number_of_rules#

holisticai.explainability.metrics.tree_number_of_rules(surrogate)[source]#

Calculates the number of rules in a decision tree surrogate model.

Parameters

surrogate: A surrogate model, typically a decision tree, for which the number of rules is to be calculated.

Returns

int: The number of rules present in the surrogate model.

Examples

>>> from sklearn.datasets import load_iris
>>> from sklearn.tree import DecisionTreeClassifier
>>> from holisticai.explainability.metrics import tree_number_of_rules
>>> X, y = load_iris(return_X_y=True)
>>> clf = DecisionTreeClassifier()
>>> clf.fit(X, y)
>>> tree_number_of_rules(clf.tree_)