predict
R2026bPredict responses using support vector machine regression model
Description
uses the yfit = predict(Mdl,X,PredictionForMissingValue=prediction)prediction value as the predicted response for
observations with missing values in the predictor data X. By
default, predict uses the median of the observed response
values in the training data. (since R2023b)
Examples
Load the carsmall data set. Consider a model that predicts a car's fuel efficiency given its horsepower and weight. Determine the sample size.
load carsmall
tbl = table(Horsepower,Weight,MPG);
N = size(tbl,1);Partition the data into training and test sets. Reserve 10% of the data for testing.
rng(10); % For reproducibility
cvp = cvpartition(N,Holdout=0.1);
idxTrn = training(cvp);
idxTest = test(cvp);Train a linear SVM regression model. Standardize the data.
Mdl = fitrsvm(tbl(idxTrn,:),"MPG",Standardize=true);Mdl is a RegressionSVM model.
Predict responses for the test set.
yfit = predict(Mdl,tbl(idxTest,:));
Create a table containing the observed response values and the predicted response values.
table(tbl.MPG(idxTest),yfit, ... VariableNames=["ObservedValue","PredictedValue"])
ans = 10×2 table
ObservedValue PredictedValue
_____________ ______________
14 9.4833
27 28.938
10 7.765
28 27.155
22 21.054
29 31.484
24.5 30.306
18.5 19.12
32 28.225
28 26.632
Input Arguments
SVM regression model, specified as a RegressionSVM or CompactRegressionSVM model
object returned by fitrsvm or compact, respectively.
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
Xmust have the same order as the predictor variables that trainedMdl.If you trained
Mdlusing a table (for example,Tbl), thenXcan be a numeric matrix ifTblcontains all numeric predictor variables. To treat numeric predictors inTblas categorical during training, identify categorical predictors using theCategoricalPredictorsname-value argument offitrsvm. IfTblcontains heterogeneous predictor variables (for example, numeric and categorical data types) andXis a numeric matrix, thenpredictthrows an error.
For a table:
predictdoes not support multicolumn variables or cell arrays other than cell arrays of character vectors.If you trained
Mdlusing a table (for example,Tbl), then all predictor variables inXmust have the same variable names and data types as those that trainedMdl(stored inMdl.PredictorNames). However, the column order ofXdoes not need to correspond to the column order ofTbl.TblandXcan contain additional variables (response variables, observation weights, etc.), butpredictignores them.If you trained
Mdlusing a numeric matrix, then the predictor names inMdl.PredictorNamesand corresponding predictor variable names inXmust be the same. To specify predictor names during training, see thePredictorNamesname-value argument offitrsvm. All predictor variables inXmust be numeric vectors.Xcan contain additional variables (response variables, observation weights, and so on), butpredictignores them.
If you set Standardize=true in
fitrsvm to train Mdl, then the
software standardizes the columns of X using the
corresponding means in Mdl.Mu and standard deviations in
Mdl.Sigma.
Data Types: table | double | single
Since R2023b
Predicted response value to use for observations with missing predictor values, specified as "median", "mean", or a numeric scalar.
| Value | Description |
|---|---|
"median" | predict uses the median of the observed response values in the training data as the predicted response value for observations with missing predictor values. |
"mean" | predict uses the mean of the observed response values in the training data as the predicted response value for observations with missing predictor values. |
| Numeric scalar | predict uses this value as the predicted response value for observations with missing predictor values. |
Example: "mean"
Example: NaN
Data Types: single | double | char | string
Output Arguments
Predicted responses, returned as a vector of length n, where n is the number of observations in the training data.
For details about how to predict responses, see Equation 1 and Equation 2 in Understanding Support Vector Machine Regression.
Tips
If
Mdlis a cross-validatedRegressionPartitionedSVMmodel, usekfoldPredictinstead ofpredictto predict new response values.
Alternative Functionality
Simulink Block
To integrate the prediction of an SVM regression model into Simulink®, you can use the RegressionSVM
Predict block in the Statistics and Machine Learning Toolbox™ library or a MATLAB® Function block with the predict function. For
examples, see Predict Responses Using RegressionSVM Predict Block and Predict Class Labels Using MATLAB Function Block.
When deciding which approach to use, consider the following:
If you use the Statistics and Machine Learning Toolbox library block, you can use the Fixed-Point Tool (Fixed-Point Designer) to convert a floating-point model to fixed point.
Support for variable-size arrays must be enabled for a MATLAB Function block with the
predictfunction.If you use a MATLAB Function block, you can use MATLAB functions for preprocessing or post-processing before or after predictions in the same MATLAB Function block.
Extended Capabilities
The
predict function fully supports tall arrays. For more
information, see Tall Arrays.
Usage notes and limitations:
You can generate C/C++ code for both
predictandupdateby using a coder configurer. Or, generate code only forpredictby usingsaveLearnerForCoder,loadLearnerForCoder, andcodegen.Code generation for
predictandupdate— Create a coder configurer by usinglearnerCoderConfigurerand then generate code by usinggenerateCode. Then you can update model parameters in the generated code without having to regenerate the code.Code generation for
predict— Save a trained model by usingsaveLearnerForCoder. Define an entry-point function that loads the saved model by usingloadLearnerForCoderand calls thepredictfunction. Then usecodegen(MATLAB Coder) to generate code for the entry-point function.
For single-precision code generation, use standardized data by specifying
Standardize=truewhen you train the model. To generate single-precision C/C++ code forpredict, specifyDataType="single"when you call theloadLearnerForCoderfunction.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 bygenerateLearnerDataTypeFcn, and then use the structure as an input argument ofloadLearnerForCoderin an entry-point function. Generating fixed-point C/C++ code requires MATLAB Coder™ and Fixed-Point Designer™.
This table contains notes about the arguments of
predict. Arguments not included in this table are fully supported.Argument Notes and Limitations MdlFor the usage notes and limitations of the model object, see Code Generation of the
CompactRegressionSVMobject.XFor general code generation,
Xmust be a single-precision or double-precision matrix or a table containing numeric variables, categorical variables, or both.In the coder configurer workflow,
Xmust be a single-precision or double-precision matrix.For fixed-point code generation,
Xmust be a fixed-point matrix.The number of rows, or observations, in
Xcan be a variable size, but the number of columns inXmust be fixed.If you want to specify
Xas a table, then your model must be trained using a table, and your entry-point function for prediction must do the following:Accept data as arrays.
Create a table from the data input arguments and specify the variable names in the table.
Pass the table to
predict.
For an example of this table workflow, see Generate Code to Classify 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).
Name-value arguments Names in name-value arguments must be compile-time constants.
If the value of
PredictionForMissingValueis nonnumeric, then it must be a compile-time constant.
For more information, see Introduction to Code Generation for Statistics and Machine Learning Functions.
Refer to the usage notes and limitations in the C/C++ Code Generation section. The same usage notes and limitations apply to GPU code generation.
This function fully supports GPU arrays. For more information, see Run MATLAB Functions on a GPU (Parallel Computing Toolbox).
Version History
Introduced in R2015bStarting in R2023b, when you predict or compute the loss, some regression models allow you to specify the predicted response value for observations with missing predictor values. Specify the PredictionForMissingValue name-value argument to use a numeric scalar, the training set median, or the training set mean as the predicted value. When computing the loss, you can also specify to omit observations with missing predictor values.
This table lists the object functions that support the
PredictionForMissingValue name-value argument. By default, the
functions use the training set median as the predicted response value for observations with
missing predictor values.
| Model Type | Model Objects | Object Functions |
|---|---|---|
| Gaussian process regression (GPR) model | RegressionGP, CompactRegressionGP | loss, predict, resubLoss, resubPredict |
RegressionPartitionedGP | kfoldLoss, kfoldPredict | |
| Gaussian kernel regression model | RegressionKernel | loss, predict |
RegressionPartitionedKernel | kfoldLoss, kfoldPredict | |
| Linear regression model | RegressionLinear | loss, predict |
RegressionPartitionedLinear | kfoldLoss, kfoldPredict | |
| Neural network regression model | RegressionNeuralNetwork, CompactRegressionNeuralNetwork | loss, predict, resubLoss, resubPredict |
RegressionPartitionedNeuralNetwork | kfoldLoss, kfoldPredict | |
| Support vector machine (SVM) regression model | RegressionSVM, CompactRegressionSVM | loss, predict, resubLoss, resubPredict |
RegressionPartitionedSVM | kfoldLoss, kfoldPredict |
In previous releases, the regression model loss and predict functions listed above used NaN predicted response values for observations with missing predictor values. The software omitted observations with missing predictor values from the resubstitution ("resub") and cross-validation ("kfold") computations for prediction and loss.
Starting in R2023a, predict fully supports GPU arrays.
See Also
RegressionSVM | CompactRegressionSVM | fitrsvm | kfoldPredict
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)