bat365 Homepage

fitrkernel

Fit Gaussian kernel regression model using random feature expansion

collapse all in page

Syntax

Mdl = fitrkernel(X,Y)

Mdl = fitrkernel(Tbl,ResponseVarName)

Mdl = fitrkernel(Tbl,formula)

Mdl = fitrkernel(Tbl,Y)

Mdl = fitrkernel(___,Name,Value)

[Mdl,FitInfo] = fitrkernel(___)

[Mdl,FitInfo,HyperparameterOptimizationResults] = fitrkernel(___)

Description

fitrkernel trains or cross-validates a Gaussian kernel regression model for nonlinear regression. fitrkernel is more practical to use for big data applications that have large training sets, but can also be applied to smaller data sets that fit in memory.

fitrkernel maps data in a low-dimensional space into a high-dimensional space, then fits a linear model in the high-dimensional space by minimizing the regularized objective function. Obtaining the linear model in the high-dimensional space is equivalent to applying the Gaussian kernel to the model in the low-dimensional space. Available linear regression models include regularized support vector machine (SVM) and least-squares regression models.

To train a nonlinear SVM regression model on in-memory data, see fitrsvm.

example

Mdl = fitrkernel(X,Y) returns a compact Gaussian kernel regression model trained using the predictor data in X and the corresponding responses in Y.

Mdl = fitrkernel(Tbl,ResponseVarName) returns a kernel regression model Mdl trained using the predictor variables contained in the table Tbl and the response values in Tbl.ResponseVarName.

Mdl = fitrkernel(Tbl,formula) returns a kernel regression model trained using the sample data in the table Tbl. The input argument formula is an explanatory model of the response and a subset of predictor variables in Tbl used to fit Mdl.

Mdl = fitrkernel(Tbl,Y) returns a kernel regression model using the predictor variables in the table Tbl and the response values in vector Y.

example

Mdl = fitrkernel(___,Name,Value) specifies options using one or more name-value pair arguments in addition to any of the input argument combinations in previous syntaxes. For example, you can implement least-squares regression, specify the number of dimension of the expanded space, or specify cross-validation options.

example

[Mdl,FitInfo] = fitrkernel(___) also returns the fit information in the structure array FitInfo using any of the input arguments in the previous syntaxes. You cannot request FitInfo for cross-validated models.

example

[Mdl,FitInfo,HyperparameterOptimizationResults] = fitrkernel(___) also returns the hyperparameter optimization results when you optimize hyperparameters by using the 'OptimizeHyperparameters' name-value pair argument.

Examples

collapse all

Train Gaussian Kernel Regression Model

Open Live Script

Train a kernel regression model for a tall array by using SVM.

When you perform calculations on tall arrays, MATLAB® uses either a parallel pool (default if you have Parallel Computing Toolbox™) or the local MATLAB session. To run the example using the local MATLAB session when you have Parallel Computing Toolbox, change the global execution environment by using the mapreducer function.

mapreducer(0)

Create a datastore that references the folder location with the data. The data can be contained in a single file, a collection of files, or an entire folder. Treat 'NA' values as missing data so that datastore replaces them with NaN values. Select a subset of the variables to use. Create a tall table on top of the datastore.

varnames = {'ArrTime','DepTime','ActualElapsedTime'};
ds = datastore('airlinesmall.csv','TreatAsMissing','NA',...
    'SelectedVariableNames',varnames);
t = tall(ds);

Specify DepTime and ArrTime as the predictor variables (X) and ActualElapsedTime as the response variable (Y). Select the observations for which ArrTime is later than DepTime.

daytime = t.ArrTime>t.DepTime;
Y = t.ActualElapsedTime(daytime);     % Response data
X = t{daytime,{'DepTime' 'ArrTime'}}; % Predictor data

Standardize the predictor variables.

Z = zscore(X); % Standardize the data

Train a default Gaussian kernel regression model with the standardized predictors. Extract a fit summary to determine how well the optimization algorithm fits the model to the data.

[Mdl,FitInfo] = fitrkernel(Z,Y)

Found 6 chunks.
|=========================================================================
| Solver | Iteration  /  |   Objective   |   Gradient    | Beta relative |
|        | Data Pass     |               |   magnitude   |    change     |
|=========================================================================
|   INIT |     0 /     1 |  4.307833e+01 |  4.345788e-02 |           NaN |
|  LBFGS |     0 /     2 |  3.705713e+01 |  1.577301e-02 |  9.988252e-01 |
|  LBFGS |     1 /     3 |  3.704022e+01 |  3.082836e-02 |  1.338410e-03 |
|  LBFGS |     2 /     4 |  3.701398e+01 |  3.006488e-02 |  1.116070e-03 |
|  LBFGS |     2 /     5 |  3.698797e+01 |  2.870642e-02 |  2.234599e-03 |
|  LBFGS |     2 /     6 |  3.693687e+01 |  2.625581e-02 |  4.479069e-03 |
|  LBFGS |     2 /     7 |  3.683757e+01 |  2.239620e-02 |  8.997877e-03 |
|  LBFGS |     2 /     8 |  3.665038e+01 |  1.782358e-02 |  1.815682e-02 |
|  LBFGS |     3 /     9 |  3.473411e+01 |  4.074480e-02 |  1.778166e-01 |
|  LBFGS |     4 /    10 |  3.684246e+01 |  1.608942e-01 |  3.294968e-01 |
|  LBFGS |     4 /    11 |  3.441595e+01 |  8.587703e-02 |  1.420892e-01 |
|  LBFGS |     5 /    12 |  3.377755e+01 |  3.760006e-02 |  4.640134e-02 |
|  LBFGS |     6 /    13 |  3.357732e+01 |  1.912644e-02 |  3.842057e-02 |
|  LBFGS |     7 /    14 |  3.334081e+01 |  3.046709e-02 |  6.211243e-02 |
|  LBFGS |     8 /    15 |  3.309239e+01 |  3.858085e-02 |  6.411356e-02 |
|  LBFGS |     9 /    16 |  3.276577e+01 |  3.612292e-02 |  6.938579e-02 |
|  LBFGS |    10 /    17 |  3.234029e+01 |  2.734959e-02 |  1.144307e-01 |
|  LBFGS |    11 /    18 |  3.205763e+01 |  2.545990e-02 |  7.323180e-02 |
|  LBFGS |    12 /    19 |  3.183341e+01 |  2.472411e-02 |  3.689625e-02 |
|  LBFGS |    13 /    20 |  3.169307e+01 |  2.064613e-02 |  2.998555e-02 |
|=========================================================================
| Solver | Iteration  /  |   Objective   |   Gradient    | Beta relative |
|        | Data Pass     |               |   magnitude   |    change     |
|=========================================================================
|  LBFGS |    14 /    21 |  3.146896e+01 |  1.788395e-02 |  5.967293e-02 |
|  LBFGS |    15 /    22 |  3.118171e+01 |  1.660696e-02 |  1.124062e-01 |
|  LBFGS |    16 /    23 |  3.106224e+01 |  1.506147e-02 |  7.947037e-02 |
|  LBFGS |    17 /    24 |  3.098395e+01 |  1.564561e-02 |  2.678370e-02 |
|  LBFGS |    18 /    25 |  3.096029e+01 |  4.464104e-02 |  4.547148e-02 |
|  LBFGS |    19 /    26 |  3.085475e+01 |  1.442800e-02 |  1.677268e-02 |
|  LBFGS |    20 /    27 |  3.078140e+01 |  1.906548e-02 |  2.275185e-02 |
|========================================================================|

Mdl = 
  RegressionKernel
            PredictorNames: {'x1'  'x2'}
              ResponseName: 'Y'
                   Learner: 'svm'
    NumExpansionDimensions: 64
               KernelScale: 1
                    Lambda: 8.5385e-06
             BoxConstraint: 1
                   Epsilon: 5.9303

FitInfo = struct with fields:
                  Solver: 'LBFGS-tall'
            LossFunction: 'epsiloninsensitive'
                  Lambda: 8.5385e-06
           BetaTolerance: 1.0000e-03
       GradientTolerance: 1.0000e-05
          ObjectiveValue: 30.7814
       GradientMagnitude: 0.0191
    RelativeChangeInBeta: 0.0228
                 FitTime: 33.7022
                 History: [1x1 struct]

Mdl is a RegressionKernel model. To inspect the regression error, you can pass Mdl and the training data or new data to the loss function. Or, you can pass Mdl and new predictor data to the predict function to predict responses for new observations. You can also pass Mdl and the training data to the resume function to continue training.

FitInfo is a structure array containing optimization information. Use FitInfo to determine whether optimization termination measurements are satisfactory.

For improved accuracy, you can increase the maximum number of optimization iterations ('IterationLimit') and decrease the tolerance values ('BetaTolerance' and 'GradientTolerance') by using the name-value pair arguments of fitrkernel. Doing so can improve measures like ObjectiveValue and RelativeChangeInBeta in FitInfo. You can also optimize model parameters by using the 'OptimizeHyperparameters' name-value pair argument.

Cross-Validate Kernel Regression Model

Open Live Script

Load the carbig data set.

load carbig

Specify the predictor variables (X) and the response variable (Y).

X = [Acceleration,Cylinders,Displacement,Horsepower,Weight];
Y = MPG;

Delete rows of X and Y where either array has NaN values. Removing rows with NaN values before passing data to fitrkernel can speed up training and reduce memory usage.

R = rmmissing([X Y]); % Data with missing entries removed
X = R(:,1:5); 
Y = R(:,end);

Cross-validate a kernel regression model using 5-fold cross-validation. Standardize the predictor variables.

Mdl = fitrkernel(X,Y,'Kfold',5,'Standardize',true)

Mdl = 
  RegressionPartitionedKernel
    CrossValidatedModel: 'Kernel'
           ResponseName: 'Y'
        NumObservations: 392
                  KFold: 5
              Partition: [1x1 cvpartition]
      ResponseTransform: 'none'

numel(Mdl.Trained)

ans = 5

Mdl is a RegressionPartitionedKernel model. Because fitrkernel implements five-fold cross-validation, Mdl contains five RegressionKernel models that the software trains on training-fold (in-fold) observations.

Examine the cross-validation loss (mean squared error) for each fold.

kfoldLoss(Mdl,'mode','individual')

Optimize Kernel Regression

Open Live Script

Optimize hyperparameters automatically using the OptimizeHyperparameters name-value argument.

Load the carbig data set.

load carbig

Specify the predictor variables (X) and the response variable (Y).

X = [Acceleration,Cylinders,Displacement,Horsepower,Weight];
Y = MPG;

Delete rows of X and Y where either array has NaN values. Removing rows with NaN values before passing data to fitrkernel can speed up training and reduce memory usage.

R = rmmissing([X Y]); % Data with missing entries removed
X = R(:,1:5); 
Y = R(:,end);

Find hyperparameters that minimize five-fold cross-validation loss by using automatic hyperparameter optimization. Specify OptimizeHyperparameters as 'auto' so that fitrkernel finds the optimal values of the KernelScale, Lambda, Epsilon, and Standardize name-value arguments. For reproducibility, set the random seed and use the 'expected-improvement-plus' acquisition function.

rng('default')
[Mdl,FitInfo,HyperparameterOptimizationResults] = fitrkernel(X,Y,'OptimizeHyperparameters','auto',...
    'HyperparameterOptimizationOptions',struct('AcquisitionFunctionName','expected-improvement-plus'))

|===================================================================================================================================|
| Iter | Eval   | Objective:  | Objective   | BestSoFar   | BestSoFar   |  KernelScale |       Lambda |      Epsilon |  Standardize |
|      | result | log(1+loss) | runtime     | (observed)  | (estim.)    |              |              |              |              |
|===================================================================================================================================|
|    1 | Best   |      4.1521 |     0.63386 |      4.1521 |      4.1521 |       11.415 |    0.0017304 |       615.77 |         true |
|    2 | Best   |      4.1489 |     0.21942 |      4.1489 |      4.1503 |       509.07 |    0.0064454 |     0.048411 |         true |
|    3 | Accept |       5.239 |      1.3138 |      4.1489 |      4.1489 |    0.0015621 |   1.8257e-05 |     0.051954 |         true |
|    4 | Accept |      4.3329 |     0.23417 |      4.1489 |      4.1489 |    0.0053278 |         2.37 |       17.883 |        false |
|    5 | Best   |      4.1454 |     0.27055 |      4.1454 |      4.1454 |     0.037693 |      0.13484 |     0.070538 |         true |
|    6 | Accept |      4.1514 |     0.25121 |      4.1454 |      4.1454 |     0.085362 |       2.3302 |     0.012669 |         true |
|    7 | Accept |      4.1521 |     0.23465 |      4.1454 |      4.1476 |       8.3355 |      0.13864 |       652.81 |         true |
|    8 | Best   |      4.1445 |     0.56417 |      4.1445 |      4.1445 |     0.013635 |    0.0093908 |      0.07593 |        false |
|    9 | Best   |      4.1119 |      1.1559 |      4.1119 |       4.112 |       9.7853 |   0.00013702 |        3.586 |        false |
|   10 | Accept |      5.4938 |      1.6813 |      4.1119 |       4.112 |     0.003459 |   1.0058e-05 |     0.015482 |        false |
|   11 | Best   |      4.0616 |     0.36318 |      4.0616 |      4.0616 |       19.733 |    0.0080593 |       2.2005 |        false |
|   12 | Best   |      2.9066 |     0.38341 |      2.9066 |      2.9067 |       989.04 |   0.00032008 |      0.23891 |        false |
|   13 | Accept |      4.0566 |     0.53308 |      2.9066 |      2.9068 |       986.63 |      0.52772 |       0.2492 |        false |
|   14 | Accept |      4.1521 |     0.31863 |      2.9066 |      2.9068 |       994.63 |   4.7511e-05 |       149.53 |        false |
|   15 | Best   |      2.8854 |     0.47769 |      2.8854 |      2.8855 |       988.58 |   0.00010361 |     0.062892 |        false |
|   16 | Accept |      2.9189 |     0.44522 |      2.8854 |      2.8855 |       921.95 |   0.00059037 |     0.031617 |        false |
|   17 | Accept |      2.8884 |     0.72628 |      2.8854 |      2.8853 |       407.11 |   0.00019778 |      0.07102 |        false |
|   18 | Best   |      2.8621 |     0.82947 |      2.8621 |      2.8627 |       446.46 |   7.6765e-05 |    0.0096939 |        false |
|   19 | Accept |         2.9 |     0.96129 |      2.8621 |       2.873 |       538.98 |   0.00015538 |     0.012166 |        false |
|   20 | Best   |      2.8329 |      1.6965 |      2.8329 |      2.8331 |       360.84 |   6.0751e-06 |    0.0090507 |        false |
|===================================================================================================================================|
| Iter | Eval   | Objective:  | Objective   | BestSoFar   | BestSoFar   |  KernelScale |       Lambda |      Epsilon |  Standardize |
|      | result | log(1+loss) | runtime     | (observed)  | (estim.)    |              |              |              |              |
|===================================================================================================================================|
|   21 | Accept |      2.9752 |      3.5333 |      2.8329 |      2.8334 |       116.54 |   1.1382e-05 |    0.0095718 |        false |
|   22 | Accept |      2.8686 |       0.998 |      2.8329 |      2.8337 |       902.99 |   1.0477e-05 |    0.0097549 |        false |
|   23 | Best   |      2.8181 |      1.4699 |      2.8181 |      2.8188 |       405.59 |   1.6728e-05 |     0.018931 |        false |
|   24 | Accept |      2.8306 |      1.8331 |      2.8181 |      2.8219 |       452.97 |   1.6794e-05 |      0.01149 |        false |
|   25 | Accept |      2.8318 |      2.3595 |      2.8181 |      2.8196 |        520.9 |   2.8621e-06 |     0.055258 |        false |
|   26 | Accept |      2.8566 |       1.558 |      2.8181 |      2.8319 |       471.46 |   5.4172e-06 |     0.025852 |        false |
|   27 | Accept |      2.8417 |     0.96279 |      2.8181 |      2.8313 |       531.03 |    1.579e-05 |     0.041394 |        false |
|   28 | Accept |      2.8396 |      2.0254 |      2.8181 |      2.8311 |        525.9 |   2.6146e-06 |     0.015122 |        false |
|   29 | Accept |      2.8474 |      1.0511 |      2.8181 |      2.8304 |       891.31 |   3.2149e-06 |      0.16166 |        false |
|   30 | Accept |      2.8486 |      1.3588 |      2.8181 |      2.8302 |       966.72 |   2.7671e-06 |     0.057709 |        false |

__________________________________________________________
Optimization completed.
MaxObjectiveEvaluations of 30 reached.
Total function evaluations: 30
Total elapsed time: 50.4136 seconds
Total objective function evaluation time: 30.4437

Best observed feasible point:
    KernelScale      Lambda      Epsilon     Standardize
    ___________    __________    ________    ___________

      405.59       1.6728e-05    0.018931       false   

Observed objective function value = 2.8181
Estimated objective function value = 2.8316
Function evaluation time = 1.4699

Best estimated feasible point (according to models):
    KernelScale      Lambda      Epsilon    Standardize
    ___________    __________    _______    ___________

      452.97       1.6794e-05    0.01149       false   

Estimated objective function value = 2.8302
Estimated function evaluation time = 1.4047

Figure contains an axes object. The axes object with title Min objective vs. Number of function evaluations, xlabel Function evaluations, ylabel Min objective contains 2 objects of type line. These objects represent Min observed objective, Estimated min objective.

Mdl = 
  RegressionKernel
              ResponseName: 'Y'
                   Learner: 'svm'
    NumExpansionDimensions: 256
               KernelScale: 452.9717
                    Lambda: 1.6794e-05
             BoxConstraint: 151.9031
                   Epsilon: 0.0115

FitInfo = struct with fields:
                  Solver: 'LBFGS-fast'
            LossFunction: 'epsiloninsensitive'
                  Lambda: 1.6794e-05
           BetaTolerance: 1.0000e-04
       GradientTolerance: 1.0000e-06
          ObjectiveValue: 2.6599
       GradientMagnitude: 0.0102
    RelativeChangeInBeta: 6.3138e-05
                 FitTime: 0.3163
                 History: []

HyperparameterOptimizationResults = 
  BayesianOptimization with properties:

                      ObjectiveFcn: @createObjFcn/inMemoryObjFcn
              VariableDescriptions: [6x1 optimizableVariable]
                           Options: [1x1 struct]
                      MinObjective: 2.8181
                   XAtMinObjective: [1x4 table]
             MinEstimatedObjective: 2.8302
          XAtMinEstimatedObjective: [1x4 table]
           NumObjectiveEvaluations: 30
                  TotalElapsedTime: 50.4136
                         NextPoint: [1x4 table]
                            XTrace: [30x4 table]
                    ObjectiveTrace: [30x1 double]
                  ConstraintsTrace: []
                     UserDataTrace: {30x1 cell}
      ObjectiveEvaluationTimeTrace: [30x1 double]
                IterationTimeTrace: [30x1 double]
                        ErrorTrace: [30x1 double]
                  FeasibilityTrace: [30x1 logical]
       FeasibilityProbabilityTrace: [30x1 double]
               IndexOfMinimumTrace: [30x1 double]
             ObjectiveMinimumTrace: [30x1 double]
    EstimatedObjectiveMinimumTrace: [30x1 double]

For big data, the optimization procedure can take a long time. If the data set is too large to run the optimization procedure, you can try to optimize the parameters using only partial data. Use the datasample function and specify 'Replace','false' to sample data without replacement.

Input Arguments

collapse all

`X` — Predictor data
numeric matrix

Predictor data to which the regression model is fit, specified as an n-by-p numeric matrix, where n is the number of observations and p is the number of predictor variables.

The length of Y and the number of observations in X must be equal.

Data Types: single | double

`Y` — Response data
numeric vector

Response data, specified as an n-dimensional numeric vector. The length of Y must be equal to the number of observations in X or Tbl.

Data Types: single | double

`Tbl` — Sample data
table

Sample data used to train the model, specified as a table. Each row of Tbl corresponds to one observation, and each column corresponds to one predictor variable. Optionally, Tbl can contain one additional column for the response variable. Multicolumn variables and cell arrays other than cell arrays of character vectors are not allowed.

If Tbl contains the response variable, and you want to use all remaining variables in Tbl as predictors, then specify the response variable by using ResponseVarName.
If Tbl contains the response variable, and you want to use only a subset of the remaining variables in Tbl as predictors, then specify a formula by using formula.
If Tbl does not contain the response variable, then specify a response variable by using Y. The length of the response variable and the number of rows in Tbl must be equal.

`ResponseVarName` — Response variable name
name of variable in `Tbl`

Response variable name, specified as the name of a variable in Tbl. The response variable must be a numeric vector.

You must specify ResponseVarName as a character vector or string scalar. For example, if Tbl stores the response variable Y as Tbl.Y, then specify it as 'Y'. Otherwise, the software treats all columns of Tbl, including Y, as predictors when training the model.

Data Types: char | string

`formula` — Explanatory model of response variable and subset of predictor variables
character vector | string scalar

Explanatory model of the response variable and a subset of the predictor variables, specified as a character vector or string scalar in the form "Y~x1+x2+x3". In this form, Y represents the response variable, and x1, x2, and x3 represent the predictor variables.

To specify a subset of variables in Tbl as predictors for training the model, use a formula. If you specify a formula, then the software does not use any variables in Tbl that do not appear in formula.

The variable names in the formula must be both variable names in Tbl (Tbl.Properties.VariableNames) and valid MATLAB^® identifiers. You can verify the variable names in Tbl by using the isvarname function. If the variable names are not valid, then you can convert them by using the matlab.lang.makeValidName function.

Data Types: char | string

Note

The software treats NaN, empty character vector (''), empty string (""), <missing>, and <undefined> elements as missing values, and removes observations with any of these characteristics:

Missing value in the response variable
At least one missing value in a predictor observation (row in X or Tbl)
NaN value or 0 weight ('Weights')

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: Mdl = fitrkernel(X,Y,Learner="leastsquares",NumExpansionDimensions=2^15,KernelScale="auto") implements least-squares regression after mapping the predictor data to the 2^15 dimensional space using feature expansion with a kernel scale parameter selected by a heuristic procedure.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: Mdl = fitrkernel(X,Y,'Learner','leastsquares','NumExpansionDimensions',2^15,'KernelScale','auto')

Note

You cannot use any cross-validation name-value argument together with the 'OptimizeHyperparameters' name-value argument. You can modify the cross-validation for 'OptimizeHyperparameters' only by using the 'HyperparameterOptimizationOptions' name-value argument.

Kernel Regression Options

collapse all

`BoxConstraint` — Box constraint
`1` (default) | positive scalar

Box constraint, specified as the comma-separated pair consisting of 'BoxConstraint' and a positive scalar.

This argument is valid only when 'Learner' is 'svm'(default) and you do not specify a value for the regularization term strength 'Lambda'. You can specify either 'BoxConstraint' or 'Lambda' because the box constraint (C) and the regularization term strength (λ) are related by C = 1/(λn), where n is the number of observations (rows in X).

Example: 'BoxConstraint',100

Data Types: single | double

`Epsilon` — Half width of epsilon-insensitive band
`'auto'` (default) | nonnegative scalar value

Half the width of the epsilon-insensitive band, specified as the comma-separated pair consisting of 'Epsilon' and 'auto' or a nonnegative scalar value.

For 'auto', the fitrkernel function determines the value of Epsilon as iqr(Y)/13.49, which is an estimate of a tenth of the standard deviation using the interquartile range of the response variable Y. If iqr(Y) is equal to zero, then fitrkernel sets the value of Epsilon to 0.1.

'Epsilon' is valid only when Learner is svm.

Example: 'Epsilon',0.3

Data Types: single | double

`NumExpansionDimensions` — Number of dimensions of expanded space
`'auto'` (default) | positive integer

Number of dimensions of the expanded space, specified as the comma-separated pair consisting of 'NumExpansionDimensions' and 'auto' or a positive integer. For 'auto', the fitrkernel function selects the number of dimensions using 2.^ceil(min(log2(p)+5,15)), where p is the number of predictors.

Example: 'NumExpansionDimensions',2^15

Data Types: char | string | single | double

`KernelScale` — Kernel scale parameter
`1` (default) | `'auto'` | positive scalar

Kernel scale parameter, specified as the comma-separated pair consisting of 'KernelScale' and 'auto' or a positive scalar. MATLAB obtains the random basis for random feature expansion by using the kernel scale parameter. For details, see Random Feature Expansion.

If you specify 'auto', then MATLAB selects an appropriate kernel scale parameter using a heuristic procedure. This heuristic procedure uses subsampling, so estimates can vary from one call to another. Therefore, to reproduce results, set a random number seed by using rng before training.

Example: 'KernelScale','auto'

Data Types: char | string | single | double

`Lambda` — Regularization term strength
`'auto'` (default) | nonnegative scalar

Regularization term strength, specified as the comma-separated pair consisting of 'Lambda' and 'auto' or a nonnegative scalar.

For 'auto', the value of Lambda is 1/n, where n is the number of observations.

When Learner is 'svm', you can specify either BoxConstraint or Lambda because the box constraint (C) and the regularization term strength (λ) are related by C = 1/(λn).

Example: 'Lambda',0.01

Data Types: char | string | single | double

`Learner` — Linear regression model type
`'svm'` (default) | `'leastsquares'`

Linear regression model type, specified as the comma-separated pair consisting of 'Learner' and 'svm' or 'leastsquares'.

In the following table, $f (x) = T (x) β + b .$

x is an observation (row vector) from p predictor variables.
$T (\cdot)$ is a transformation of an observation (row vector) for feature expansion. T(x) maps x in $ℝ^{p}$ to a high-dimensional space ( $ℝ^{m}$ ).
β is a vector of coefficients.
b is the scalar bias.

Value	Algorithm	Response range	Loss function
`'leastsquares'`	Linear regression via ordinary least squares	y ∊ (-∞,∞)	Mean squared error (MSE): $ℓ [y, f (x)] = \frac{1}{2} {[y - f (x)]}^{2}$
`'svm'`	Support vector machine regression	Same as `'leastsquares'`	Epsilon-insensitive: $ℓ [y, f (x)] = \max [0, \| y - f (x) \| - ε]$

Example: 'Learner','leastsquares'

`Standardize` — Flag to standardize predictor data
`false` or `0` (default) | `true` or `1`

Since R2023b

Flag to standardize the predictor data, specified as a numeric or logical 0 (false) or 1 (true). If you set Standardize to true, then the software centers and scales each numeric predictor variable by the corresponding column mean and standard deviation. The software does not standardize the categorical predictors.

Example: "Standardize",true

Data Types: single | double | logical

`Verbose` — Verbosity level
`0` (default) | `1`

Verbosity level, specified as the comma-separated pair consisting of 'Verbose' and either 0 or 1. Verbose controls the amount of diagnostic information fitrkernel displays at the command line.

Value	Description
`0`	`fitrkernel` does not display diagnostic information.
`1`	`fitrkernel` displays and stores the value of the objective function, gradient magnitude, and other diagnostic information. `FitInfo.History` contains the diagnostic information.

Example: 'Verbose',1

Data Types: single | double

`BlockSize` — Maximum amount of allocated memory
`4e^3` (4GB) (default) | positive scalar

Maximum amount of allocated memory (in megabytes), specified as the comma-separated pair consisting of 'BlockSize' and a positive scalar.

If fitrkernel requires more memory than the value of BlockSize to hold the transformed predictor data, then MATLAB uses a block-wise strategy. For details about the block-wise strategy, see Algorithms.

Example: 'BlockSize',1e4

Data Types: single | double

`RandomStream` — Random number stream
global stream (default) | random stream object

Random number stream for reproducibility of data transformation, specified as the comma-separated pair consisting of 'RandomStream' and a random stream object. For details, see Random Feature Expansion.

Use 'RandomStream' to reproduce the random basis functions that fitrkernel uses to transform the data in X to a high-dimensional space. For details, see Managing the Global Stream Using RandStream and Creating and Controlling a Random Number Stream.

Example: 'RandomStream',RandStream('mlfg6331_64')

Other Regression Options

collapse all

`CategoricalPredictors` — Categorical predictors list
vector of positive integers | logical vector | character matrix | string array | cell array of character vectors | `'all'`

Categorical predictors list, specified as one of the values in this table.

Value	Description
Vector of positive integers	Each entry in the vector is an index value indicating that the corresponding predictor is categorical. The index values are between 1 and `p`, where `p` is the number of predictors used to train the model. If `fitrkernel` uses a subset of input variables as predictors, then the function indexes the predictors using only the subset. The `CategoricalPredictors` values do not count the response variable, observation weights variable, or any other variables that the function does not use.
Logical vector	A `true` entry means that the corresponding predictor is categorical. The length of the vector is `p`.
Character matrix	Each row of the matrix is the name of a predictor variable. The names must match the entries in `PredictorNames`. Pad the names with extra blanks so each row of the character matrix has the same length.
String array or cell array of character vectors	Each element in the array is the name of a predictor variable. The names must match the entries in `PredictorNames`.
`"all"`	All predictors are categorical.

By default, if the predictor data is in a table (Tbl), fitrkernel assumes that a variable is categorical if it is a logical vector, categorical vector, character array, string array, or cell array of character vectors. If the predictor data is a matrix (X), fitrkernel assumes that all predictors are continuous. To identify any other predictors as categorical predictors, specify them by using the CategoricalPredictors name-value argument.

For the identified categorical predictors, fitrkernel creates dummy variables using two different schemes, depending on whether a categorical variable is unordered or ordered. For an unordered categorical variable, fitrkernel creates one dummy variable for each level of the categorical variable. For an ordered categorical variable, fitrkernel creates one less dummy variable than the number of categories. For details, see Automatic Creation of Dummy Variables.

Example: 'CategoricalPredictors','all'

`PredictorNames` — Predictor variable names
string array of unique names | cell array of unique character vectors

Predictor variable names, specified as a string array of unique names or cell array of unique character vectors. The functionality of PredictorNames depends on the way you supply the training data.

If you supply X and Y, then you can use PredictorNames to assign names to the predictor variables in X.
- The order of the names in PredictorNames must correspond to the column order of X. That is, PredictorNames{1} is the name of X(:,1), PredictorNames{2} is the name of X(:,2), and so on. Also, size(X,2) and numel(PredictorNames) must be equal.
- By default, PredictorNames is {'x1','x2',...}.
If you supply Tbl, then you can use PredictorNames to choose which predictor variables to use in training. That is, fitrkernel uses only the predictor variables in PredictorNames and the response variable during training.
- PredictorNames must be a subset of Tbl.Properties.VariableNames and cannot include the name of the response variable.
- By default, PredictorNames contains the names of all predictor variables.
- A good practice is to specify the predictors for training using either PredictorNames or formula, but not both.

Example: "PredictorNames",["SepalLength","SepalWidth","PetalLength","PetalWidth"]

Data Types: string | cell

`ResponseName` — Response variable name
`"Y"` (default) | character vector | string scalar

Response variable name, specified as a character vector or string scalar.

If you supply Y, then you can use ResponseName to specify a name for the response variable.
If you supply ResponseVarName or formula, then you cannot use ResponseName.

Example: "ResponseName","response"

Data Types: char | string

`ResponseTransform` — Response transformation
`'none'` (default) | function handle

Response transformation, specified as either 'none' or a function handle. The default is 'none', which means @(y)y, or no transformation. For a MATLAB function or a function you define, use its function handle for the response transformation. The function handle must accept a vector (the original response values) and return a vector of the same size (the transformed response values).

Example: Suppose you create a function handle that applies an exponential transformation to an input vector by using myfunction = @(y)exp(y). Then, you can specify the response transformation as 'ResponseTransform',myfunction.

Data Types: char | string | function_handle

`Weights` — Observation weights
vector of scalar values | name of variable in `Tbl`

Observation weights, specified as the comma-separated pair consisting of 'Weights' and a vector of scalar values or the name of a variable in Tbl. The software weights each observation (or row) in X or Tbl with the corresponding value in Weights. The length of Weights must equal the number of rows in X or Tbl.

If you specify the input data as a table Tbl, then Weights can be the name of a variable in Tbl that contains a numeric vector. In this case, you must specify Weights as a character vector or string scalar. For example, if weights vector W is stored as Tbl.W, then specify it as 'W'. Otherwise, the software treats all columns of Tbl, including W, as predictors when training the model.

By default, Weights is ones(n,1), where n is the number of observations in X or Tbl.

fitrkernel normalizes the weights to sum to 1.

Data Types: single | double | char | string

Cross-Validation Options

collapse all

`CrossVal` — Cross-validation flag
`'off'` (default) | `'on'`

Cross-validation flag, specified as the comma-separated pair consisting of 'Crossval' and 'on' or 'off'.

If you specify 'on', then the software implements 10-fold cross-validation.

You can override this cross-validation setting using the CVPartition, Holdout, KFold, or Leaveout name-value pair argument. You can use only one cross-validation name-value pair argument at a time to create a cross-validated model.

Example: 'Crossval','on'

`CVPartition` — Cross-validation partition
`[]` (default) | `cvpartition` object

Cross-validation partition, specified as a cvpartition object that specifies the type of cross-validation and the indexing for the training and validation sets.

To create a cross-validated model, you can specify only one of these four name-value arguments: CVPartition, Holdout, KFold, or Leaveout.

Example: Suppose you create a random partition for 5-fold cross-validation on 500 observations by using cvp = cvpartition(500,KFold=5). Then, you can specify the cross-validation partition by setting CVPartition=cvp.

`Holdout` — Fraction of data for holdout validation
scalar value in the range (0,1)

Fraction of the data used for holdout validation, specified as a scalar value in the range [0,1]. If you specify Holdout=p, then the software completes these steps:

Randomly select and reserve p*100% of the data as validation data, and train the model using the rest of the data.
Store the compact trained model in the Trained property of the cross-validated model.

To create a cross-validated model, you can specify only one of these four name-value arguments: CVPartition, Holdout, KFold, or Leaveout.

Example: Holdout=0.1

Data Types: double | single

`KFold` — Number of folds
`10` (default) | positive integer value greater than 1

Number of folds to use in the cross-validated model, specified as a positive integer value greater than 1. If you specify KFold=k, then the software completes these steps:

Randomly partition the data into k sets.
For each set, reserve the set as validation data, and train the model using the other k – 1 sets.
Store the k compact trained models in a k-by-1 cell vector in the Trained property of the cross-validated model.

To create a cross-validated model, you can specify only one of these four name-value arguments: CVPartition, Holdout, KFold, or Leaveout.

Example: KFold=5

Data Types: single | double

`Leaveout` — Leave-one-out cross-validation flag
`'off'` (default) | `'on'`

Leave-one-out cross-validation flag, specified as the comma-separated pair consisting of 'Leaveout' and 'on' or 'off'. If you specify 'Leaveout','on', then, for each of the n observations (where n is the number of observations excluding missing observations), the software completes these steps:

Reserve the observation as validation data, and train the model using the other n – 1 observations.
Store the n compact, trained models in the cells of an n-by-1 cell vector in the Trained property of the cross-validated model.

To create a cross-validated model, you can use one of these four name-value pair arguments only: CVPartition, Holdout, KFold, or Leaveout.

Example: 'Leaveout','on'

Convergence Controls

collapse all

`BetaTolerance` — Relative tolerance on linear coefficients and bias term
`1e-4` (default) | nonnegative scalar

Relative tolerance on the linear coefficients and the bias term (intercept), specified as a nonnegative scalar.

Let $B_{t} = [β_{t}^{'} b_{t}]$ , that is, the vector of the coefficients and the bias term at optimization iteration t. If ${‖ \frac{B_{t} - B_{t - 1}}{B_{t}} ‖}_{2} < BetaTolerance$ , then optimization terminates.

If you also specify GradientTolerance, then optimization terminates when the software satisfies either stopping criterion.

Example: 'BetaTolerance',1e-6

Data Types: single | double

`GradientTolerance` — Absolute gradient tolerance
`1e-6` (default) | nonnegative scalar

Absolute gradient tolerance, specified as a nonnegative scalar.

Let $\nabla ℒ_{t}$ be the gradient vector of the objective function with respect to the coefficients and bias term at optimization iteration t. If ${‖ \nabla ℒ_{t} ‖}_{\infty} = \max | \nabla ℒ_{t} | < GradientTolerance$ , then optimization terminates.

If you also specify BetaTolerance, then optimization terminates when the software satisfies either stopping criterion.

Example: 'GradientTolerance',1e-5

Data Types: single | double

`HessianHistorySize` — Size of history buffer for Hessian approximation
`15` (default) | positive integer

Size of the history buffer for Hessian approximation, specified as the comma-separated pair consisting of 'HessianHistorySize' and a positive integer. At each iteration, fitrkernel composes the Hessian by using statistics from the latest HessianHistorySize iterations.

Example: 'HessianHistorySize',10

Data Types: single | double

`IterationLimit` — Maximum number of optimization iterations
positive integer

Maximum number of optimization iterations, specified as the comma-separated pair consisting of 'IterationLimit' and a positive integer.

The default value is 1000 if the transformed data fits in memory, as specified by BlockSize. Otherwise, the default value is 100.

Example: 'IterationLimit',500

Data Types: single | double

Hyperparameter Optimization Options

collapse all

`OptimizeHyperparameters` — Parameters to optimize
`'none'` (default) | `'auto'` | `'all'` | string array or cell array of eligible parameter names | vector of `optimizableVariable` objects

Parameters to optimize, specified as the comma-separated pair consisting of 'OptimizeHyperparameters' and one of these values:

'none' — Do not optimize.
'auto' — Use {'KernelScale','Lambda','Epsilon','Standardize'}.
'all' — Optimize all eligible parameters.
Cell array of eligible parameter names.
Vector of optimizableVariable objects, typically the output of hyperparameters.

The optimization attempts to minimize the cross-validation loss (error) for fitrkernel by varying the parameters. To control the cross-validation type and other aspects of the optimization, use the HyperparameterOptimizationOptions name-value pair argument.

Note

The values of 'OptimizeHyperparameters' override any values you specify using other name-value arguments. For example, setting 'OptimizeHyperparameters' to 'auto' causes fitrkernel to optimize hyperparameters corresponding to the 'auto' option and to ignore any specified values for the hyperparameters.

The eligible parameters for fitrkernel are:

Epsilon — fitrkernel searches among positive values, by default log-scaled in the range [1e-3,1e2]*iqr(Y)/1.349.
KernelScale — fitrkernel searches among positive values, by default log-scaled in the range [1e-3,1e3].
Lambda — fitrkernel searches among positive values, by default log-scaled in the range [1e-3,1e3]/n, where n is the number of observations.
Learner — fitrkernel searches among 'svm' and 'leastsquares'.
NumExpansionDimensions — fitrkernel searches among positive integers, by default log-scaled in the range [100,10000].
Standardize — fitrkernel searches among true and false.

Set nondefault parameters by passing a vector of optimizableVariable objects that have nondefault values. For example:

load carsmall
params = hyperparameters('fitrkernel',[Horsepower,Weight],MPG);
params(2).Range = [1e-4,1e6];

Pass params as the value of 'OptimizeHyperparameters'.

By default, the iterative display appears at the command line, and plots appear according to the number of hyperparameters in the optimization. For the optimization and plots, the objective function is log(1 + cross-validation loss). To control the iterative display, set the Verbose field of the 'HyperparameterOptimizationOptions' name-value argument. To control the plots, set the ShowPlots field of the 'HyperparameterOptimizationOptions' name-value argument.

For an example, see Optimize Kernel Regression.

Example: 'OptimizeHyperparameters','auto'

`HyperparameterOptimizationOptions` — Options for optimization
structure

Options for optimization, specified as a structure. This argument modifies the effect of the OptimizeHyperparameters name-value argument. All fields in the structure are optional.

Field Name	Values	Default
`Optimizer`	`'bayesopt'` — Use Bayesian optimization. Internally, this setting calls `bayesopt`. `'gridsearch'` — Use grid search with `NumGridDivisions` values per dimension. `'randomsearch'` — Search at random among `MaxObjectiveEvaluations` points. `'gridsearch'` searches in a random order, using uniform sampling without replacement from the grid. After optimization, you can get a table in grid order by using the command `sortrows(Mdl.HyperparameterOptimizationResults)`.	`'bayesopt'`
`AcquisitionFunctionName`	`'expected-improvement-per-second-plus'` `'expected-improvement'` `'expected-improvement-plus'` `'expected-improvement-per-second'` `'lower-confidence-bound'` `'probability-of-improvement'` Acquisition functions whose names include `per-second` do not yield reproducible results because the optimization depends on the runtime of the objective function. Acquisition functions whose names include `plus` modify their behavior when they are overexploiting an area. For more details, see Acquisition Function Types.	`'expected-improvement-per-second-plus'`
`MaxObjectiveEvaluations`	Maximum number of objective function evaluations.	`30` for `'bayesopt'` and `'randomsearch'`, and the entire grid for `'gridsearch'`
`MaxTime`	Time limit, specified as a positive real scalar. The time limit is in seconds, as measured by `tic` and `toc`. The run time can exceed `MaxTime` because `MaxTime` does not interrupt function evaluations.	`Inf`
`NumGridDivisions`	For `'gridsearch'`, the number of values in each dimension. The value can be a vector of positive integers giving the number of values for each dimension, or a scalar that applies to all dimensions. This field is ignored for categorical variables.	`10`
`ShowPlots`	Logical value indicating whether to show plots. If `true`, this field plots the best observed objective function value against the iteration number. If you use Bayesian optimization (`Optimizer` is `'bayesopt'`), then this field also plots the best estimated objective function value. The best observed objective function values and best estimated objective function values correspond to the values in the `BestSoFar (observed)` and `BestSoFar (estim.)` columns of the iterative display, respectively. You can find these values in the properties `ObjectiveMinimumTrace` and `EstimatedObjectiveMinimumTrace` of `Mdl.HyperparameterOptimizationResults`. If the problem includes one or two optimization parameters for Bayesian optimization, then `ShowPlots` also plots a model of the objective function against the parameters.	`true`
`SaveIntermediateResults`	Logical value indicating whether to save results when `Optimizer` is `'bayesopt'`. If `true`, this field overwrites a workspace variable named `'BayesoptResults'` at each iteration. The variable is a `BayesianOptimization` object.	`false`
`Verbose`	Display at the command line: `0` — No iterative display `1` — Iterative display `2` — Iterative display with extra information For details, see the `bayesopt` `Verbose` name-value argument and the example Optimize Classifier Fit Using Bayesian Optimization.	`1`
`UseParallel`	Logical value indicating whether to run Bayesian optimization in parallel, which requires Parallel Computing Toolbox™. Due to the nonreproducibility of parallel timing, parallel Bayesian optimization does not necessarily yield reproducible results. For details, see Parallel Bayesian Optimization.	`false`
`Repartition`	Logical value indicating whether to repartition the cross-validation at every iteration. If this field is `false`, the optimizer uses a single partition for the optimization. The setting `true` usually gives the most robust results because it takes partitioning noise into account. However, for good results, `true` requires at least twice as many function evaluations.	`false`
Use no more than one of the following three options.
`CVPartition`	A `cvpartition` object, as created by `cvpartition`	`'Kfold',5` if you do not specify a cross-validation field
`Holdout`	A scalar in the range `(0,1)` representing the holdout fraction
`Kfold`	An integer greater than 1

Example: 'HyperparameterOptimizationOptions',struct('MaxObjectiveEvaluations',60)

Data Types: struct

Output Arguments

collapse all

`Mdl` — Trained kernel regression model
`RegressionKernel` model object | `RegressionPartitionedKernel` cross-validated model object

Trained kernel regression model, returned as a RegressionKernel model object or RegressionPartitionedKernel cross-validated model object.

If you set any of the name-value pair arguments CrossVal, CVPartition, Holdout, KFold, or Leaveout, then Mdl is a RegressionPartitionedKernel cross-validated model. Otherwise, Mdl is a RegressionKernel model.

To reference properties of Mdl, use dot notation. For example, enter Mdl.NumExpansionDimensions in the Command Window to display the number of dimensions of the expanded space.

Note

Unlike other regression models, and for economical memory usage, a RegressionKernel model object does not store the training data or training process details (for example, convergence history).

`FitInfo` — Optimization details
structure array

Optimization details, returned as a structure array including fields described in this table. The fields contain final values or name-value pair argument specifications.

Field	Description
`Solver`	Objective function minimization technique: `'LBFGS-fast'`, `'LBFGS-blockwise'`, or `'LBFGS-tall'`. For details, see Algorithms.
`LossFunction`	Loss function. Either mean squared error (MSE) or epsilon-insensitive, depending on the type of linear regression model. See `Learner`.
`Lambda`	Regularization term strength. See `Lambda`.
`BetaTolerance`	Relative tolerance on the linear coefficients and the bias term. See `BetaTolerance`.
`GradientTolerance`	Absolute gradient tolerance. See `GradientTolerance`.
`ObjectiveValue`	Value of the objective function when optimization terminates. The regression loss plus the regularization term compose the objective function.
`GradientMagnitude`	Infinite norm of the gradient vector of the objective function when optimization terminates. See `GradientTolerance`.
`RelativeChangeInBeta`	Relative changes in the linear coefficients and the bias term when optimization terminates. See `BetaTolerance`.
`FitTime`	Elapsed, wall-clock time (in seconds) required to fit the model to the data.
`History`	History of optimization information. This field also includes the optimization information from training `Mdl`. This field is empty (`[]`) if you specify `'Verbose',0`. For details, see `Verbose` and Algorithms.

To access fields, use dot notation. For example, to access the vector of objective function values for each iteration, enter FitInfo.ObjectiveValue in the Command Window.

Examine the information provided by FitInfo to assess whether convergence is satisfactory.

`HyperparameterOptimizationResults` — Cross-validation optimization of hyperparameters
`BayesianOptimization` object | table of hyperparameters and associated values

Cross-validation optimization of hyperparameters, returned as a BayesianOptimization object or a table of hyperparameters and associated values. The output is nonempty when the value of 'OptimizeHyperparameters' is not 'none'. The output value depends on the Optimizer field value of the 'HyperparameterOptimizationOptions' name-value pair argument:

Value of `Optimizer` Field	Value of `HyperparameterOptimizationResults`
`'bayesopt'` (default)	Object of class `BayesianOptimization`
`'gridsearch'` or `'randomsearch'`	Table of hyperparameters used, observed objective function values (cross-validation loss), and rank of observations from lowest (best) to highest (worst)

More About

collapse all

Random Feature Expansion

Random feature expansion, such as Random Kitchen Sinks[1] or Fastfood[2], is a scheme to approximate Gaussian kernels of the kernel regression algorithm for big data in a computationally efficient way. Random feature expansion is more practical for big data applications that have large training sets, but can also be applied to smaller data sets that fit in memory.

After mapping the predictor data into a high-dimensional space, the kernel regression algorithm searches for an optimal function that deviates from each response data point (y_i) by values no greater than the epsilon margin (ε).

Some regression problems cannot be described adequately using a linear model. In such cases, obtain a nonlinear regression model by replacing the dot product x₁x₂′ with a nonlinear kernel function $G (x_{1}, x_{2}) = 〈 φ (x_{1}), φ (x_{2}) 〉$ , where x_i is the ith observation (row vector) and φ(x_i) is a transformation that maps x_i to a high-dimensional space (called the “kernel trick”). However, evaluating G(x₁,x₂), the Gram matrix, for each pair of observations is computationally expensive for a large data set (large n).

The random feature expansion scheme finds a random transformation so that its dot product approximates the Gaussian kernel. That is,

$G (x_{1}, x_{2}) = 〈 φ (x_{1}), φ (x_{2}) 〉 \approx T (x_{1}) T (x_{2})',$

where T(x) maps x in $ℝ^{p}$ to a high-dimensional space ( $ℝ^{m}$ ). The Random Kitchen Sinks[1] scheme uses the random transformation

$T (x) = m^{- 1 / 2} \exp (i Z x')',$

where $Z \in ℝ^{m \times p}$ is a sample drawn from $N (0, σ^{- 2})$ and σ is a kernel scale. This scheme requires O(mp) computation and storage. The Fastfood[2] scheme introduces another random basis V instead of Z using Hadamard matrices combined with Gaussian scaling matrices. This random basis reduces computation cost to O(mlogp) and reduces storage to O(m).

You can specify values for m and σ, using the NumExpansionDimensions and KernelScale name-value pair arguments of fitrkernel, respectively.

The fitrkernel function uses the Fastfood scheme for random feature expansion and uses linear regression to train a Gaussian kernel regression model. Unlike solvers in the fitrsvm function, which require computation of the n-by-n Gram matrix, the solver in fitrkernel only needs to form a matrix of size n-by-m, with m typically much less than n for big data.

Box Constraint

A box constraint is a parameter that controls the maximum penalty imposed on observations that lie outside the epsilon margin (ε), and helps to prevent overfitting (regularization). Increasing the box constraint can lead to longer training times.

The box constraint (C) and the regularization term strength (λ) are related by C = 1/(λn), where n is the number of observations.

Tips

Standardizing predictors before training a model can be helpful.
- You can standardize training data and scale test data to have the same scale as the training data by using the normalize function.
- Alternatively, use the Standardize name-value argument to standardize the numeric predictors before training. The returned model includes the predictor means and standard deviations in its Mu and Sigma properties, respectively. (since R2023b)
After training a model, you can generate C/C++ code that predicts responses for new data. Generating C/C++ code requires MATLAB Coder™. For details, see Introduction to Code Generation.

Algorithms

fitrkernel minimizes the regularized objective function using a Limited-memory Broyden-Fletcher-Goldfarb-Shanno (LBFGS) solver with ridge (L₂) regularization. To find the type of LBFGS solver used for training, type FitInfo.Solver in the Command Window.

'LBFGS-fast' — LBFGS solver.
'LBFGS-blockwise' — LBFGS solver with a block-wise strategy. If fitrkernel requires more memory than the value of BlockSize to hold the transformed predictor data, then the function uses a block-wise strategy.
'LBFGS-tall' — LBFGS solver with a block-wise strategy for tall arrays.

When fitrkernel uses a block-wise strategy, it implements LBFGS by distributing the calculation of the loss and gradient among different parts of the data at each iteration. Also, fitrkernel refines the initial estimates of the linear coefficients and the bias term by fitting the model locally to parts of the data and combining the coefficients by averaging. If you specify 'Verbose',1, then fitrkernel displays diagnostic information for each data pass and stores the information in the History field of FitInfo.

When fitrkernel does not use a block-wise strategy, the initial estimates are zeros. If you specify 'Verbose',1, then fitrkernel displays diagnostic information for each iteration and stores the information in the History field of FitInfo.

References

[1] Rahimi, A., and B. Recht. “Random Features for Large-Scale Kernel Machines.” Advances in Neural Information Processing Systems. Vol. 20, 2008, pp. 1177–1184.

[2] Le, Q., T. Sarlós, and A. Smola. “Fastfood — Approximating Kernel Expansions in Loglinear Time.” Proceedings of the 30th International Conference on Machine Learning. Vol. 28, No. 3, 2013, pp. 244–252.

[3] Huang, P. S., H. Avron, T. N. Sainath, V. Sindhwani, and B. Ramabhadran. “Kernel methods match Deep Neural Networks on TIMIT.” 2014 IEEE International Conference on Acoustics, Speech and Signal Processing. 2014, pp. 205–209.

Extended Capabilities

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

Usage notes and limitations:

fitrkernel does not support tall table data.
Some name-value pair arguments have different defaults compared to the default values for the in-memory fitrkernel function. Supported name-value pair arguments, and any differences, are:
- 'BoxConstraint'
- 'Epsilon'
- 'NumExpansionDimensions'
- 'KernelScale'
- 'Lambda'
- 'Learner'
- 'Verbose' — Default value is 1.
- 'BlockSize'
- 'RandomStream'
- 'ResponseTransform'
- 'Weights' — Value must be a tall array.
- 'BetaTolerance' — Default value is relaxed to 1e–3.
- 'GradientTolerance' — Default value is relaxed to 1e–5.
- 'HessianHistorySize'
- 'IterationLimit' — Default value is relaxed to 20.
- 'OptimizeHyperparameters'
- 'HyperparameterOptimizationOptions' — For cross-validation, tall optimization supports only 'Holdout' validation. By default, the software selects and reserves 20% of the data as holdout validation data, and trains the model using the rest of the data. You can specify a different value for the holdout fraction by using this argument. For example, specify 'HyperparameterOptimizationOptions',struct('Holdout',0.3) to reserve 30% of the data as validation data.
If 'KernelScale' is 'auto', then fitrkernel uses the random stream controlled by tallrng for subsampling. For reproducibility, you must set a random number seed for both the global stream and the random stream controlled by tallrng.
If 'Lambda' is 'auto', then fitrkernel might take an extra pass through the data to calculate the number of observations in X.
fitrkernel uses a block-wise strategy. For details, see Algorithms.

For more information, see Tall Arrays.

Automatic Parallel Support
Accelerate code by automatically running computation in parallel using Parallel Computing Toolbox™.

To perform parallel hyperparameter optimization, use the 'HyperparameterOptimizationOptions', struct('UseParallel',true) name-value argument in the call to the fitrkernel function.

For more information on parallel hyperparameter optimization, see Parallel Bayesian Optimization.

For general information about parallel computing, see Run MATLAB Functions with Automatic Parallel Support (Parallel Computing Toolbox).

Version History

Introduced in R2018a

expand all

R2023b: Kernel models support standardization of predictors

Starting in R2023b, fitrkernel supports the standardization of numeric predictors. That is, you can specify the Standardize value as true to center and scale each numeric predictor variable by the corresponding column mean and standard deviation. The software does not standardize the categorical predictors.

You can also optimize the Standardize hyperparameter by using the OptimizeHyperparameters name-value argument. Unlike in previous releases, when you specify "auto" as the OptimizeHyperparameters value, fitrkernel includes Standardize as an optimizable hyperparameter.

fitrkernel

Syntax

Description

Examples

Train Gaussian Kernel Regression Model

Cross-Validate Kernel Regression Model

Optimize Kernel Regression

Input Arguments

X — Predictor data numeric matrix

Y — Response data numeric vector

Tbl — Sample data table

ResponseVarName — Response variable name name of variable in Tbl

formula — Explanatory model of response variable and subset of predictor variables character vector | string scalar

Name-Value Arguments

BoxConstraint — Box constraint 1 (default) | positive scalar

Epsilon — Half width of epsilon-insensitive band 'auto' (default) | nonnegative scalar value

NumExpansionDimensions — Number of dimensions of expanded space 'auto' (default) | positive integer

KernelScale — Kernel scale parameter 1 (default) | 'auto' | positive scalar

Lambda — Regularization term strength 'auto' (default) | nonnegative scalar

Learner — Linear regression model type 'svm' (default) | 'leastsquares'

Standardize — Flag to standardize predictor data false or 0 (default) | true or 1

Verbose — Verbosity level 0 (default) | 1

BlockSize — Maximum amount of allocated memory 4e^3 (4GB) (default) | positive scalar

RandomStream — Random number stream global stream (default) | random stream object

CategoricalPredictors — Categorical predictors list vector of positive integers | logical vector | character matrix | string array | cell array of character vectors | 'all'

PredictorNames — Predictor variable names string array of unique names | cell array of unique character vectors

ResponseName — Response variable name "Y" (default) | character vector | string scalar

ResponseTransform — Response transformation 'none' (default) | function handle

Weights — Observation weights vector of scalar values | name of variable in Tbl

CrossVal — Cross-validation flag 'off' (default) | 'on'

CVPartition — Cross-validation partition [] (default) | cvpartition object

Holdout — Fraction of data for holdout validation scalar value in the range (0,1)

KFold — Number of folds 10 (default) | positive integer value greater than 1

Leaveout — Leave-one-out cross-validation flag 'off' (default) | 'on'

BetaTolerance — Relative tolerance on linear coefficients and bias term 1e-4 (default) | nonnegative scalar

GradientTolerance — Absolute gradient tolerance 1e-6 (default) | nonnegative scalar

HessianHistorySize — Size of history buffer for Hessian approximation 15 (default) | positive integer

IterationLimit — Maximum number of optimization iterations positive integer

OptimizeHyperparameters — Parameters to optimize 'none' (default) | 'auto' | 'all' | string array or cell array of eligible parameter names | vector of optimizableVariable objects

HyperparameterOptimizationOptions — Options for optimization structure

Output Arguments

Mdl — Trained kernel regression model RegressionKernel model object | RegressionPartitionedKernel cross-validated model object

FitInfo — Optimization details structure array

HyperparameterOptimizationResults — Cross-validation optimization of hyperparameters BayesianOptimization object | table of hyperparameters and associated values

More About

Random Feature Expansion

Box Constraint

Tips

Algorithms

References

Extended Capabilities

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

Automatic Parallel Support Accelerate code by automatically running computation in parallel using Parallel Computing Toolbox™.

Version History

R2023b: Kernel models support standardization of predictors

See Also

Topics

`X` — Predictor data
numeric matrix

`Y` — Response data
numeric vector

`Tbl` — Sample data
table

`ResponseVarName` — Response variable name
name of variable in `Tbl`

`formula` — Explanatory model of response variable and subset of predictor variables
character vector | string scalar

`BoxConstraint` — Box constraint
`1` (default) | positive scalar

`Epsilon` — Half width of epsilon-insensitive band
`'auto'` (default) | nonnegative scalar value

`NumExpansionDimensions` — Number of dimensions of expanded space
`'auto'` (default) | positive integer

`KernelScale` — Kernel scale parameter
`1` (default) | `'auto'` | positive scalar

`Lambda` — Regularization term strength
`'auto'` (default) | nonnegative scalar

`Learner` — Linear regression model type
`'svm'` (default) | `'leastsquares'`

`Standardize` — Flag to standardize predictor data
`false` or `0` (default) | `true` or `1`

`Verbose` — Verbosity level
`0` (default) | `1`

`BlockSize` — Maximum amount of allocated memory
`4e^3` (4GB) (default) | positive scalar

`RandomStream` — Random number stream
global stream (default) | random stream object

`CategoricalPredictors` — Categorical predictors list
vector of positive integers | logical vector | character matrix | string array | cell array of character vectors | `'all'`

`PredictorNames` — Predictor variable names
string array of unique names | cell array of unique character vectors

`ResponseName` — Response variable name
`"Y"` (default) | character vector | string scalar

`ResponseTransform` — Response transformation
`'none'` (default) | function handle

`Weights` — Observation weights
vector of scalar values | name of variable in `Tbl`

`CrossVal` — Cross-validation flag
`'off'` (default) | `'on'`

`CVPartition` — Cross-validation partition
`[]` (default) | `cvpartition` object

`Holdout` — Fraction of data for holdout validation
scalar value in the range (0,1)

`KFold` — Number of folds
`10` (default) | positive integer value greater than 1

`Leaveout` — Leave-one-out cross-validation flag
`'off'` (default) | `'on'`

`BetaTolerance` — Relative tolerance on linear coefficients and bias term
`1e-4` (default) | nonnegative scalar

`GradientTolerance` — Absolute gradient tolerance
`1e-6` (default) | nonnegative scalar

`HessianHistorySize` — Size of history buffer for Hessian approximation
`15` (default) | positive integer

`IterationLimit` — Maximum number of optimization iterations
positive integer

`OptimizeHyperparameters` — Parameters to optimize
`'none'` (default) | `'auto'` | `'all'` | string array or cell array of eligible parameter names | vector of `optimizableVariable` objects

`HyperparameterOptimizationOptions` — Options for optimization
structure

`Mdl` — Trained kernel regression model
`RegressionKernel` model object | `RegressionPartitionedKernel` cross-validated model object

`FitInfo` — Optimization details
structure array

`HyperparameterOptimizationResults` — Cross-validation optimization of hyperparameters
`BayesianOptimization` object | table of hyperparameters and associated values

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

Automatic Parallel Support
Accelerate code by automatically running computation in parallel using Parallel Computing Toolbox™.