predict

Predict responses using ensemble of regression models

Syntax

Yfit = predict(Mdl,X)

Yfit = predict(Mdl,X,Name,Value)

Description

Yfit = predict(Mdl,X) returns predicted responses to the predictor data in the table or matrix X, based on the regression ensemble model Mdl.

Yfit = predict(Mdl,X,Name,Value) uses additional options specified by one or more Name,Value pair arguments.

Input Arguments

Mdl

Regression ensemble created by fitrensemble, or by the compact method.

X

Predictor data used to generate responses, specified as a numeric matrix or table. Each row of X corresponds to one observation, and each column corresponds to one variable. For a numeric matrix: The variables making up the columns of X must have the same order as the predictor variables that trained Mdl. If you trained Mdl using a table (for example, Tbl), then X can be a numeric matrix if Tbl contains all numeric predictor variables. To treat numeric predictors in Tbl as categorical during training, identify categorical predictors using the CategoricalPredictors name-value pair argument of fitrensemble. If Tbl contains heterogeneous predictor variables (for example, numeric and categorical data types) and X is a numeric matrix, then predict throws an error. For a table: predict does not support multi-column variables and cell arrays other than cell arrays of character vectors. If you trained Mdl using a table (for example, Tbl), then all predictor variables in X must have the same variable names and data types as those that trained Mdl (stored in Mdl.PredictorNames). However, the column order of X does not need to correspond to the column order of Tbl. Tbl and X can contain additional variables (response variables, observation weights, etc.), but predict ignores them. If you trained Mdl using a numeric matrix, then the predictor names in Mdl.PredictorNames and corresponding predictor variable names in X must be the same. To specify predictor names during training, see the PredictorNames name-value pair argument of fitrensemble. All predictor variables in X must be numeric vectors. X can contain additional variables (response variables, observation weights, etc.), but predict ignores them.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

'Learners'	Indices of weak learners in the ensemble ranging from 1 to NumTrained, where NumTrained is the number of weak learners. Default: 1:NumTrained
'UseObsForLearner'	A logical matrix of size N-by-NumTrained, where N is the number of observations in X, and NumTrained is the number of weak learners. When UseObsForLearner(I,J) is true, predict uses learner J in predicting observation I. Default: true(N,NumTrained)

Output Arguments

Yfit	A numeric column vector with the same number of rows as TBLdata or Xdata. Each row of Yfit gives the predicted response to the corresponding row of TBLdata or Xdata, based on the ens regression model.

Examples

Predict Responses Based on Regression Ensemble

Find the predicted mileage for a car based on regression ensemble trained on the carsmall data.

Load the carsmall data set and select the number of cylinders, engine displacement, horsepower, and vehicle weight as predictors.

load carsmall
X = [Cylinders Displacement Horsepower Weight];

Train an ensemble of regression trees and predict MPG for a four-cylinder car, with 200 cubic inch engine displacement, 150 horsepower, weighing 3000 lbs.

rens = fitrensemble(X,MPG);
Mileage = predict(rens,[4 200 150 3000])

Mileage = 25.6467

Extended Capabilities

Tall Arrays

Calculate with arrays that have more rows than fit in memory.

This function fully supports tall arrays. You can use models trained on either in-memory or tall data with this function.

For more information, see Tall Arrays.

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

• Use saveLearnerForCoder, loadLearnerForCoder, and codegen (MATLAB Coder) to generate code for the predict function. Save a trained model by using saveLearnerForCoder. Define an entry-point function that loads the saved model by using loadLearnerForCoder and calls the predict function. Then use codegen to generate code for the entry-point function.

• You can also generate single-precision C/C++ code for predict. For single-precision code generation, specify the name-value pair argument 'DataType','single' as an additional input to the loadLearnerForCoder function.

• You can also generate fixed-point C/C++ code for predict. Fixed-point code generation requires an additional step that defines the fixed-point data types of the variables required for prediction. Create a fixed-point data type structure by using the data type function generated by generateLearnerDataTypeFcn, and use the structure as an input argument of loadLearnerForCoder in an entry-point function. Generating fixed-point C/C++ code requires MATLAB^® Coder™ and Fixed-Point Designer™.

• Generating fixed-point code for predict includes propagating data types for individual learners and, therefore, can be time consuming.

• This table contains notes about the arguments of predict. Arguments not included in this table are fully supported.

  Argument	Notes and Limitations
  Mdl	For the usage notes and limitations of the model object, see Code Generation of the CompactRegressionEnsemble object.
  X	For general code generation, X must be a single-precision or double-precision matrix or a table containing single or double predictor variables. If you want to specify X as a table, then your model must be trained using a table, and you must ensure that your entry-point function for prediction: Accepts data as arrays Creates a table from the data input arguments and specifies the variable names in the table Passes the table to predict For an example of this table workflow, see Generate Code to Classify Numeric Data in Table. For more information on using tables in code generation, see Code Generation for Tables (MATLAB Coder) and Table Limitations for Code Generation (MATLAB Coder). For fixed-point code generation, X must be a fixed-point matrix. The number of rows, or observations, in X can be a variable size, but the number of columns in X must be fixed.
  Name-value pair arguments	Names in name-value pair arguments must be compile-time constants. For example, to allow user-defined indices up to 5 weak learners in the generated code, include {coder.Constant('Learners'),coder.typeof(0,[1,5],[0,1])} in the -args value of codegen (MATLAB Coder).
  'Learners'	For fixed-point code generation, the 'Learners' value must have an integer data type.

For more information, see Introduction to Code Generation.