The RegressionTree class implements a Regression Tree that recursively partitions the dataset (x, y) by finding a threshold for each feature/x-variable. The threshold for a feature is the value that minimizes sseL + sseR, the sum of the "sum of squared errors".
Value parameters
- branchValue
-
the branch value for the tree node (defaults to -1)
- curDepth
-
current depth (defaults to 0)
- feature
-
the feature for the tree's parent node (defaults to -1)
- fname_
-
the names of the model's features/variables (defaults to null)
- hparam
-
the hyper-parameters for the model (defaults to RegressionTree.hp)
- leaves
-
the leaf counter (defaults to Counter ())
- use_r_fb
-
whether to use (by regression tree) feature bagging (fb) i.e., use a subset of the features, @see
RegressionTreeRFwith parameteruse_fb - x
-
the m-by-n input/data matrix
- y
-
the output/response m-vector
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Type members
Inherited classlikes
The BestStep is used to record the best improvement step found so far.
The BestStep is used to record the best improvement step found so far.
Value parameters
- col
-
the column/variable to ADD/REMOVE for this step
- mod
-
the model including selected features/variables for this step
- qof
-
the Quality of Fit (QoF) for this step
Attributes
- Inherited from:
- Predictor
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Value members
Concrete methods
Build a sub-model that is restricted to the given columns of the data matrix.
Build a sub-model that is restricted to the given columns of the data matrix.
Value parameters
- x_cols
-
the columns that the new model is restricted to
Attributes
- Definition Classes
Return the number of leaves in this tree.
Return the number of leaves in this tree.
Attributes
Given a data matrix z, predict the value by following the tree to the leaf.
Given a data matrix z, predict the value by following the tree to the leaf.
Value parameters
- z
-
the data matrix to predict
Attributes
- Definition Classes
Print the regression tree in Pre-Order using printT method.
Print the regression tree in Pre-Order using printT method.
Attributes
Print out the regression tree using Breadth First Search (BFS).
Print out the regression tree using Breadth First Search (BFS).
Attributes
Test a predictive model y_ = f(x_) + e and return its QoF vector. Testing may be be in-sample (on the training set) or out-of-sample (on the testing set) as determined by the parameters passed in. Note: must call train before test.
Test a predictive model y_ = f(x_) + e and return its QoF vector. Testing may be be in-sample (on the training set) or out-of-sample (on the testing set) as determined by the parameters passed in. Note: must call train before test.
Value parameters
- x_
-
the testing/full data/input matrix (defaults to full x)
- y_
-
the testing/full response/output vector (defaults to full y)
Attributes
Train the regression tree by selecting thresholds for the features/variables in matrix x_.
Train the regression tree by selecting thresholds for the features/variables in matrix x_.
Value parameters
- x_
-
the training/full data/input matrix
- y_
-
the training/full response/output vector
Attributes
Train the regression tree by selecting thresholds for the features/variables in matrix x_. This method uses feature bagging (fb), e.g., as used in Random Forest.
Train the regression tree by selecting thresholds for the features/variables in matrix x_. This method uses feature bagging (fb), e.g., as used in Random Forest.
Value parameters
- x_
-
the training/full data/input matrix
- y_
-
the training/full response/output vector
Attributes
Inherited methods
Perform backward elimination to find the least predictive variable to remove from the existing model, returning the variable to eliminate, the new parameter vector and the new Quality of Fit (QoF). May be called repeatedly.
Perform backward elimination to find the least predictive variable to remove from the existing model, returning the variable to eliminate, the new parameter vector and the new Quality of Fit (QoF). May be called repeatedly.
Value parameters
- cols
-
the columns of matrix x currently included in the existing model
- first
-
first variable to consider for elimination (default (1) assume intercept x_0 will be in any model)
- idx_q
-
index of Quality of Fit (QoF) to use for comparing quality
Attributes
- See also
-
Fitfor index of QoF measures. - Inherited from:
- Predictor
Perform backward elimination to find the least predictive variables to remove from the full model, returning the variables left and the new Quality of Fit (QoF) measures for all steps.
Perform backward elimination to find the least predictive variables to remove from the full model, returning the variables left and the new Quality of Fit (QoF) measures for all steps.
Value parameters
- cross
-
whether to include the cross-validation QoF measure
- first
-
first variable to consider for elimination
- idx_q
-
index of Quality of Fit (QoF) to use for comparing quality
Attributes
- See also
-
Fitfor index of QoF measures. - Inherited from:
- Predictor
Attributes
- Inherited from:
- Predictor
Diagnose the health of the model by computing the Quality of Fit (QoF) measures, from the error/residual vector and the predicted & actual responses. For some models the instances may be weighted.
Diagnose the health of the model by computing the Quality of Fit (QoF) measures, from the error/residual vector and the predicted & actual responses. For some models the instances may be weighted.
Value parameters
- w
-
the weights on the instances (defaults to null)
- y
-
the actual response/output vector to use (test/full)
- yp
-
the predicted response/output vector (test/full)
Attributes
- See also
-
Regression_WLS - Definition Classes
- Inherited from:
- Fit
Return the Quality of Fit (QoF) measures corresponding to the labels given. Note, if sse > sst, the model introduces errors and the rSq may be negative, otherwise, R^2 (rSq) ranges from 0 (weak) to 1 (strong). Override to add more quality of fit measures.
Return the Quality of Fit (QoF) measures corresponding to the labels given. Note, if sse > sst, the model introduces errors and the rSq may be negative, otherwise, R^2 (rSq) ranges from 0 (weak) to 1 (strong). Override to add more quality of fit measures.
Attributes
- Inherited from:
- Fit
Perform forward selection to find the most predictive variable to add the existing model, returning the variable to add and the new model. May be called repeatedly.
Perform forward selection to find the most predictive variable to add the existing model, returning the variable to add and the new model. May be called repeatedly.
Value parameters
- cols
-
the columns of matrix x currently included in the existing model
- idx_q
-
index of Quality of Fit (QoF) to use for comparing quality
Attributes
- See also
-
Fitfor index of QoF measures. - Inherited from:
- Predictor
Perform forward selection to find the most predictive variables to have in the model, returning the variables added and the new Quality of Fit (QoF) measures for all steps.
Perform forward selection to find the most predictive variables to have in the model, returning the variables added and the new Quality of Fit (QoF) measures for all steps.
Value parameters
- cross
-
whether to include the cross-validation QoF measure
- idx_q
-
index of Quality of Fit (QoF) to use for comparing quality
Attributes
- See also
-
Fitfor index of QoF measures. - Inherited from:
- Predictor
Return the best model found from feature selection.
Return the feature/variable names.
Return the used data matrix x. Mainly for derived classes where x is expanded from the given columns in x_, e.g., SymbolicRegression.quadratic adds squared columns.
Return the used data matrix x. Mainly for derived classes where x is expanded from the given columns in x_, e.g., SymbolicRegression.quadratic adds squared columns.
Attributes
- Inherited from:
- Predictor
Return the used response vector y. Mainly for derived classes where y is transformed, e.g., TranRegression, ARX.
Return the used response vector y. Mainly for derived classes where y is transformed, e.g., TranRegression, ARX.
Attributes
- Inherited from:
- Predictor
Return the help string that describes the Quality of Fit (QoF) measures provided by the Fit trait. Override to correspond to fitLabel.
Return the help string that describes the Quality of Fit (QoF) measures provided by the Fit trait. Override to correspond to fitLabel.
Attributes
- Inherited from:
- Fit
Return the hyper-parameters.
Return the relative importance of selected variables, ordered highest to lowest, rescaled so the highest is one.
Return the relative importance of selected variables, ordered highest to lowest, rescaled so the highest is one.
Value parameters
- cols
-
the selected columns/features/variables
- rSq
-
the matrix R^2 values (stand in for sse)
Attributes
- Inherited from:
- Predictor
The log-likelihood function times -2. Override as needed.
The log-likelihood function times -2. Override as needed.
Value parameters
- ms
-
raw Mean Squared Error
- s2
-
MLE estimate of the population variance of the residuals
Attributes
- See also
- Inherited from:
- Fit
Return the mean of the squares for error (sse / df). Must call diagnose first.
Return the mean of the squares for error (sse / df). Must call diagnose first.
Attributes
- Inherited from:
- Fit
Return the number of terms/parameters in the model, e.g., b_0 + b_1 x_1 + b_2 x_2 has three terms.
Return the number of terms/parameters in the model, e.g., b_0 + b_1 x_1 + b_2 x_2 has three terms.
Attributes
- Inherited from:
- Predictor
Return the vector of parameter/coefficient values.
Return the coefficient of determination (R^2). Must call diagnose first.
Return the coefficient of determination (R^2). Must call diagnose first.
Attributes
- Inherited from:
- FitM
Return a basic report on a trained and tested multi-variate model.
Return a basic report on a trained and tested multi-variate model.
Value parameters
- ftMat
-
the matrix of qof values produced by the
Fittrait
Attributes
- Inherited from:
- Model
Return a basic report on a trained and tested model.
Return a basic report on a trained and tested model.
Value parameters
- ftVec
-
the vector of qof values produced by the
Fittrait
Attributes
- Inherited from:
- Model
Reset the best-step to default
Reset the degrees of freedom to the new updated values. For some models, the degrees of freedom is not known until after the model is built.
Reset the degrees of freedom to the new updated values. For some models, the degrees of freedom is not known until after the model is built.
Value parameters
- df_update
-
the updated degrees of freedom (model, error)
Attributes
- Inherited from:
- Fit
Return the vector of residuals/errors.
Perform feature selection to find the most predictive variables to have in the model, returning the variables added and the new Quality of Fit (QoF) measures for all steps.
Perform feature selection to find the most predictive variables to have in the model, returning the variables added and the new Quality of Fit (QoF) measures for all steps.
Value parameters
- cross
-
whether to include the cross-validation QoF measure
- idx_q
-
index of Quality of Fit (QoF) to use for comparing quality
- tech
-
the feature selection technique to apply
Attributes
- See also
-
Fitfor index of QoF measures. - Inherited from:
- Predictor
Return the sum of the squares for error (sse). Must call diagnose first.
Return the sum of the squares for error (sse). Must call diagnose first.
Attributes
- Inherited from:
- FitM
Perform stepwise regression to find the most predictive variables to have in the model, returning the variables left and the new Quality of Fit (QoF) measures for all steps. At each step it calls forwardSel and backwardElim and takes the best of the two actions. Stops when neither action yields improvement.
Perform stepwise regression to find the most predictive variables to have in the model, returning the variables left and the new Quality of Fit (QoF) measures for all steps. At each step it calls forwardSel and backwardElim and takes the best of the two actions. Stops when neither action yields improvement.
Value parameters
- cross
-
whether to include the cross-validation QoF measure
- idx_q
-
index of Quality of Fit (QoF) to use for comparing quality
Attributes
- See also
-
Fitfor index of QoF measures. - Inherited from:
- Predictor
Produce a QoF summary for a model with diagnostics for each predictor x_j and the overall Quality of Fit (QoF). Note: `Fac_Cholesky is used to compute the inverse of xtx.
Produce a QoF summary for a model with diagnostics for each predictor x_j and the overall Quality of Fit (QoF). Note: `Fac_Cholesky is used to compute the inverse of xtx.
Value parameters
- b
-
the parameters/coefficients for the model
- fname
-
the array of feature/variable names
- vifs
-
the Variance Inflation Factors (VIFs)
- x_
-
the testing/full data/input matrix
Attributes
- Inherited from:
- Fit
Return the indices for the test-set.
Return the indices for the test-set.
Value parameters
- n_test
-
the size of test-set
- rando
-
whether to select indices randomly or in blocks
Attributes
- See also
-
scalation.mathstat.TnT_Split - Inherited from:
- Predictor
The train2 method should work like the train method, but should also optimize hyper-parameters (e.g., shrinkage or learning rate). Only implementing classes needing this capability should override this method.
The train2 method should work like the train method, but should also optimize hyper-parameters (e.g., shrinkage or learning rate). Only implementing classes needing this capability should override this method.
Value parameters
- x_
-
the training/full data/input matrix (defaults to full x)
- y_
-
the training/full response/output vector (defaults to full y)
Attributes
- Inherited from:
- Predictor
Train and test the predictive model y_ = f(x_) + e and report its QoF and plot its predictions. Return the predictions and QoF. FIX - currently must override if y is transformed, @see TranRegression
Train and test the predictive model y_ = f(x_) + e and report its QoF and plot its predictions. Return the predictions and QoF. FIX - currently must override if y is transformed, @see TranRegression
Value parameters
- x_
-
the training/full data/input matrix (defaults to full x)
- xx
-
the testing/full data/input matrix (defaults to full x)
- y_
-
the training/full response/output vector (defaults to full y)
- yy
-
the testing/full response/output vector (defaults to full y)
Attributes
- Inherited from:
- Predictor
Attributes
- Inherited from:
- Predictor
Compute the Variance Inflation Factor (VIF) for each variable to test for multi-collinearity by regressing x_j against the rest of the variables. A VIF over 50 indicates that over 98% of the variance of x_j can be predicted from the other variables, so x_j may be a candidate for removal from the model. Note: override this method to use a superior regression technique.
Compute the Variance Inflation Factor (VIF) for each variable to test for multi-collinearity by regressing x_j against the rest of the variables. A VIF over 50 indicates that over 98% of the variance of x_j can be predicted from the other variables, so x_j may be a candidate for removal from the model. Note: override this method to use a superior regression technique.
Value parameters
- skip
-
the number of columns of x at the beginning to skip in computing VIF
Attributes
- Inherited from:
- Predictor
Inherited fields
The optional reference to an ontological concept