treeple.tree.PatchObliqueDecisionTreeRegressor#

class treeple.tree.PatchObliqueDecisionTreeRegressor(*, criterion='squared_error', splitter='best', max_depth=None, min_samples_split=2, min_samples_leaf=1, min_weight_fraction_leaf=0.0, max_features=None, random_state=None, max_leaf_nodes=None, min_impurity_decrease=0.0, min_patch_dims=None, max_patch_dims=None, dim_contiguous=None, data_dims=None, boundary=None, feature_weight=None, ccp_alpha=0.0, store_leaf_values=False, monotonic_cst=None)[source]#

A oblique decision tree regressor that operates over patches of data.

A patch oblique decision tree is also known as a manifold oblique decision tree (called MORF in [1]), where the splitter is aware of the structure in the data. For example, in an image, a patch would be contiguous along the rows and columns of the image. In a multivariate time-series, a patch would be contiguous over time, but possibly discontiguous over the sensors.

Parameters:
criterion{“squared_error”, “friedman_mse”, “absolute_error”, “poisson”}, default=”squared_error”

The function to measure the quality of a split. Supported criteria are “squared_error” for the mean squared error, which is equal to variance reduction as feature selection criterion and minimizes the L2 loss using the mean of each terminal node, “friedman_mse”, which uses mean squared error with Friedman’s improvement score for potential splits, “absolute_error” for the mean absolute error, which minimizes the L1 loss using the median of each terminal node, and “poisson” which uses reduction in Poisson deviance to find splits.

splitter{“best”, “random”}, default=”best”

The strategy used to choose the split at each node. Supported strategies are “best” to choose the best split and “random” to choose the best random split.

max_depthint, default=None

The maximum depth of the tree. If None, then nodes are expanded until all leaves are pure or until all leaves contain less than min_samples_split samples.

min_samples_splitint or float, default=2

The minimum number of samples required to split an internal node:

  • If int, then consider min_samples_split as the minimum number.

  • If float, then min_samples_split is a fraction and ceil(min_samples_split * n_samples) are the minimum number of samples for each split.

min_samples_leafint or float, default=1

The minimum number of samples required to be at a leaf node. A split point at any depth will only be considered if it leaves at least min_samples_leaf training samples in each of the left and right branches. This may have the effect of smoothing the model, especially in regression.

  • If int, then consider min_samples_leaf as the minimum number.

  • If float, then min_samples_leaf is a fraction and ceil(min_samples_leaf * n_samples) are the minimum number of samples for each node.

min_weight_fraction_leaffloat, default=0.0

The minimum weighted fraction of the sum total of weights (of all the input samples) required to be at a leaf node. Samples have equal weight when sample_weight is not provided.

max_featuresint, float or {“auto”, “sqrt”, “log2”}, default=None

The number of features to consider when looking for the best split:

  • If int, then consider max_features features at each split.

  • If float, then max_features is a fraction and int(max_features * n_features) features are considered at each split.

  • If “auto”, then max_features=sqrt(n_features).

  • If “sqrt”, then max_features=sqrt(n_features).

  • If “log2”, then max_features=log2(n_features).

  • If None, then max_features=n_features.

Note: the search for a split does not stop until at least one valid partition of the node samples is found, even if it requires to effectively inspect more than max_features features. Note: Compared to axis-aligned Random Forests, one can set max_features to a number greater then n_features.

random_stateint, RandomState instance or None, default=None

Controls the randomness of the estimator. The features are always randomly permuted at each split, even if splitter is set to "best". When max_features < n_features, the algorithm will select max_features at random at each split before finding the best split among them. But the best found split may vary across different runs, even if max_features=n_features. That is the case, if the improvement of the criterion is identical for several splits and one split has to be selected at random. To obtain a deterministic behaviour during fitting, random_state has to be fixed to an integer. See Glossary for details.

max_leaf_nodesint, default=None

Grow a tree with max_leaf_nodes in best-first fashion. Best nodes are defined as relative reduction in impurity. If None then unlimited number of leaf nodes.

min_impurity_decreasefloat, default=0.0

A node will be split if this split induces a decrease of the impurity greater than or equal to this value.

The weighted impurity decrease equation is the following:

N_t / N * (impurity - N_t_R / N_t * right_impurity
                    - N_t_L / N_t * left_impurity)

where N is the total number of samples, N_t is the number of samples at the current node, N_t_L is the number of samples in the left child, and N_t_R is the number of samples in the right child.

N, N_t, N_t_R and N_t_L all refer to the weighted sum, if sample_weight is passed.

min_patch_dimsarray_like, optional

The minimum dimensions of a patch, by default 1 along all dimensions.

max_patch_dimsarray_like, optional

The maximum dimensions of a patch, by default 1 along all dimensions.

dim_contiguousarray_like of bool, optional

Whether or not each patch is sampled contiguously along this dimension.

data_dimsarray_like, optional

The presumed dimensions of the un-vectorized feature vector, by default will be a 1D vector with (1, n_features) shape.

boundaryoptional, str {‘wrap’}

The boundary condition to use when sampling patches, by default None. ‘wrap’ corresponds to the boundary condition as is in numpy and scipy.

feature_weightarray_like of shape (n_samples,n_features,), default=None

Feature weights. If None, then features are equally weighted as is. If provided, then the feature weights are used to weight the patches that are generated. The feature weights are used as follows: for every patch that is sampled, the feature weights over the entire patch is summed and normalizes the patch.

ccp_alphanon-negative float, default=0.0

Not used.

store_leaf_valuesbool, default=False

Whether to store the leaf values.

monotonic_cstarray_like of int of shape (n_features), default=None
Indicates the monotonicity constraint to enforce on each feature.
  • 1: monotonic increase

  • 0: no constraint

  • -1: monotonic decrease

Not used.

Attributes:
feature_importances_ndarray of shape (n_features,)

Return the feature importances.

max_features_int

The inferred value of max_features.

n_features_in_int

Number of features seen during fit.

feature_names_in_ndarray of shape (n_features_in_,)

Names of features seen during fit. Defined only when X has feature names that are all strings.

n_outputs_int

The number of outputs when fit is performed.

tree_Tree instance

The underlying Tree object. Please refer to help(sklearn.tree._tree.Tree) for attributes of Tree object.

min_patch_dims_array_like

The minimum dimensions of a patch.

max_patch_dims_array_like

The maximum dimensions of a patch.

data_dims_array_like

The presumed dimensions of the un-vectorized feature vector.

Methods

apply(X[, check_input])

Return the index of the leaf that each sample is predicted as.

compute_similarity_matrix(X)

Compute the similarity matrix of samples in X.

cost_complexity_pruning_path(X, y[, ...])

Compute the pruning path during Minimal Cost-Complexity Pruning.

decision_path(X[, check_input])

Return the decision path in the tree.

fit(X, y[, sample_weight, check_input, classes])

Build a decision tree regressor from the training set (X, y).

get_depth()

Return the depth of the decision tree.

get_leaf_node_samples(X[, check_input])

For each datapoint x in X, get the training samples in the leaf node.

get_metadata_routing()

Get metadata routing of this object.

get_n_leaves()

Return the number of leaves of the decision tree.

get_params([deep])

Get parameters for this estimator.

predict(X[, check_input])

Predict class or regression value for X.

predict_quantiles(X[, quantiles, method, ...])

Predict class or regression value for X at given quantiles.

score(X, y[, sample_weight])

Return the coefficient of determination of the prediction.

set_fit_request(*[, check_input, classes, ...])

Request metadata passed to the fit method.

set_params(**params)

Set the parameters of this estimator.

set_predict_request(*[, check_input])

Request metadata passed to the predict method.

set_score_request(*[, sample_weight])

Request metadata passed to the score method.

Notes

Patches are 2D masks that are applied onto the data matrix. Following sklearn API standards, X is always a (n_samples, n_features) array even if X is comprised of images, or multivariate-time series. The data_width and data_height parameters are used to inform the PatchObliqueDecisionTreeRegressor of the original structure of the data. It is required that data_width * data_height = n_features.

When users pass in X to fit(), tt is presumed that all vectorization operations are done C-contiguously (i.e. the last axis is contiguous).

Note that for a patch height and width of size 1, the tree is exactly the same as the decision tree, albeit with less efficienc optimizations. Therefore, it is always recommended to set the range of patch heights and widths based on the structure of your expected input data.

References

Examples

>>> from sklearn.datasets import load_diabetes
>>> from sklearn.model_selection import cross_val_score
>>> X, y = load_diabetes(return_X_y=True)
>>> from treeple.tree import PatchObliqueDecisionTreeRegressor as RGS
>>> regressor = RGS(random_state=0)
>>> cross_val_score(regressor, X, y, cv=10)
...                    
...
array([-0.10163671, -0.78786738,  0.01490768,  0.32737289, -0.24816698,
        0.41881754,  0.0588273 , -1.48722913, -0.07927208, -0.15600762])
apply(X, check_input=True)#

Return the index of the leaf that each sample is predicted as.

New in version 0.17.

Parameters:
X{array_like, sparse matrix} of shape (n_samples, n_features)

The input samples. Internally, it will be converted to dtype=np.float32 and if a sparse matrix is provided to a sparse csr_matrix.

check_inputbool, default=True

Allow to bypass several input checking. Don’t use this parameter unless you know what you’re doing.

Returns:
X_leavesarray_like of shape (n_samples,)

For each datapoint x in X, return the index of the leaf x ends up in. Leaves are numbered within [0; self.tree_.node_count), possibly with gaps in the numbering.

compute_similarity_matrix(X)#

Compute the similarity matrix of samples in X.

Parameters:
Xarray_like of shape (n_samples, n_features)

The input data.

Returns:
sim_matrixarray_like of shape (n_samples, n_samples)

The similarity matrix among the samples.

cost_complexity_pruning_path(X, y, sample_weight=None)#

Compute the pruning path during Minimal Cost-Complexity Pruning.

See Minimal Cost-Complexity Pruning for details on the pruning process.

Parameters:
X{array_like, sparse matrix} of shape (n_samples, n_features)

The training input samples. Internally, it will be converted to dtype=np.float32 and if a sparse matrix is provided to a sparse csc_matrix.

yarray_like of shape (n_samples,) or (n_samples, n_outputs)

The target values (class labels) as integers or strings.

sample_weightarray_like of shape (n_samples,), default=None

Sample weights. If None, then samples are equally weighted. Splits that would create child nodes with net zero or negative weight are ignored while searching for a split in each node. Splits are also ignored if they would result in any single class carrying a negative weight in either child node.

Returns:
ccp_pathBunch

Dictionary-like object, with the following attributes.

ccp_alphasndarray

Effective alphas of subtree during pruning.

impuritiesndarray

Sum of the impurities of the subtree leaves for the corresponding alpha value in ccp_alphas.

decision_path(X, check_input=True)#

Return the decision path in the tree.

New in version 0.18.

Parameters:
X{array_like, sparse matrix} of shape (n_samples, n_features)

The input samples. Internally, it will be converted to dtype=np.float32 and if a sparse matrix is provided to a sparse csr_matrix.

check_inputbool, default=True

Allow to bypass several input checking. Don’t use this parameter unless you know what you’re doing.

Returns:
indicatorsparse matrix of shape (n_samples, n_nodes)

Return a node indicator CSR matrix where non zero elements indicates that the samples goes through the nodes.

fit(X, y, sample_weight=None, check_input=True, classes=None)#

Build a decision tree regressor from the training set (X, y).

Parameters:
X{array_like, sparse matrix} of shape (n_samples, n_features)

The training input samples. Internally, it will be converted to dtype=np.float32 and if a sparse matrix is provided to a sparse csc_matrix.

yarray_like of shape (n_samples,) or (n_samples, n_outputs)

The target values (real numbers). Use dtype=np.float64 and order='C' for maximum efficiency.

sample_weightarray_like of shape (n_samples,), default=None

Sample weights. If None, then samples are equally weighted. Splits that would create child nodes with net zero or negative weight are ignored while searching for a split in each node.

check_inputbool, default=True

Allow to bypass several input checking. Don’t use this parameter unless you know what you’re doing.

classesarray_like of shape (n_classes,), default=None

List of all the classes that can possibly appear in the y vector.

Returns:
selfDecisionTreeRegressor

Fitted estimator.

get_depth()#

Return the depth of the decision tree.

The depth of a tree is the maximum distance between the root and any leaf.

Returns:
self.tree_.max_depthint

The maximum depth of the tree.

get_leaf_node_samples(X, check_input=True)#

For each datapoint x in X, get the training samples in the leaf node.

Parameters:
Xarray_like of shape (n_samples, n_features)

Dataset to apply the forest to.

check_inputbool, default=True

Allow to bypass several input checking.

Returns:
leaf_nodes_samplesa list of array_like of length (n_samples,)

Each sample is represented by the indices of the training samples that reached the leaf node. The n_leaf_node_samples may vary between samples, since the number of samples that fall in a leaf node is variable. Each array has shape (n_leaf_node_samples, n_outputs).

get_metadata_routing()#

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:
routingMetadataRequest

A MetadataRequest encapsulating routing information.

get_n_leaves()#

Return the number of leaves of the decision tree.

Returns:
self.tree_.n_leavesint

Number of leaves.

get_params(deep=True)#

Get parameters for this estimator.

Parameters:
deepbool, default=True

If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:
paramsdict

Parameter names mapped to their values.

predict(X, check_input=True)#

Predict class or regression value for X.

For a classification model, the predicted class for each sample in X is returned. For a regression model, the predicted value based on X is returned.

Parameters:
X{array_like, sparse matrix} of shape (n_samples, n_features)

The input samples. Internally, it will be converted to dtype=np.float32 and if a sparse matrix is provided to a sparse csr_matrix.

check_inputbool, default=True

Allow to bypass several input checking. Don’t use this parameter unless you know what you’re doing.

Returns:
yarray_like of shape (n_samples,) or (n_samples, n_outputs)

The predicted classes, or the predict values.

predict_quantiles(X, quantiles=0.5, method='nearest', check_input=True)#

Predict class or regression value for X at given quantiles.

Parameters:
X{array_like, sparse matrix} of shape (n_samples, n_features)

Input data.

quantilesfloat, optional

The quantiles at which to evaluate, by default 0.5 (median).

methodstr, optional

The method to interpolate, by default ‘linear’. Can be any keyword argument accepted by numpy.quantile().

check_inputbool, optional

Whether or not to check input, by default True.

Returns:
predictionsarray_like of shape (n_samples, n_outputs, len(quantiles))

The predicted quantiles.

score(X, y, sample_weight=None)#

Return the coefficient of determination of the prediction.

The coefficient of determination \(R^2\) is defined as \((1 - \frac{u}{v})\), where \(u\) is the residual sum of squares ((y_true - y_pred)** 2).sum() and \(v\) is the total sum of squares ((y_true - y_true.mean()) ** 2).sum(). The best possible score is 1.0 and it can be negative (because the model can be arbitrarily worse). A constant model that always predicts the expected value of y, disregarding the input features, would get a \(R^2\) score of 0.0.

Parameters:
Xarray_like of shape (n_samples, n_features)

Test samples. For some estimators this may be a precomputed kernel matrix or a list of generic objects instead with shape (n_samples, n_samples_fitted), where n_samples_fitted is the number of samples used in the fitting for the estimator.

yarray_like of shape (n_samples,) or (n_samples, n_outputs)

True values for X.

sample_weightarray_like of shape (n_samples,), default=None

Sample weights.

Returns:
scorefloat

\(R^2\) of self.predict(X) w.r.t. y.

Notes

The \(R^2\) score used when calling score on a regressor uses multioutput='uniform_average' from version 0.23 to keep consistent with default value of r2_score(). This influences the score method of all the multioutput regressors (except for MultiOutputRegressor).

set_fit_request(*, check_input='$UNCHANGED$', classes='$UNCHANGED$', sample_weight='$UNCHANGED$')#

Request metadata passed to the fit method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

  • True: metadata is requested, and passed to fit if provided. The request is ignored if metadata is not provided.

  • False: metadata is not requested and the meta-estimator will not pass it to fit.

  • None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

New in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:
check_inputstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for check_input parameter in fit.

classesstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for classes parameter in fit.

sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for sample_weight parameter in fit.

Returns:
selfobject

The updated object.

set_params(**params)#

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:
**paramsdict

Estimator parameters.

Returns:
selfestimator instance

Estimator instance.

set_predict_request(*, check_input='$UNCHANGED$')#

Request metadata passed to the predict method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

  • True: metadata is requested, and passed to predict if provided. The request is ignored if metadata is not provided.

  • False: metadata is not requested and the meta-estimator will not pass it to predict.

  • None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

New in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:
check_inputstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for check_input parameter in predict.

Returns:
selfobject

The updated object.

set_score_request(*, sample_weight='$UNCHANGED$')#

Request metadata passed to the score method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

  • True: metadata is requested, and passed to score if provided. The request is ignored if metadata is not provided.

  • False: metadata is not requested and the meta-estimator will not pass it to score.

  • None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

New in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:
sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for sample_weight parameter in score.

Returns:
selfobject

The updated object.

property feature_importances_#

Return the feature importances.

The importance of a feature is computed as the (normalized) total reduction of the criterion brought by that feature. It is also known as the Gini importance.

Warning: impurity-based feature importances can be misleading for high cardinality features (many unique values). See sklearn.inspection.permutation_importance() as an alternative.

Returns:
feature_importances_ndarray of shape (n_features,)

Normalized total reduction of criteria by feature (Gini importance).