fitrlinear
Fit linear regression model to highdimensional data
Syntax
Description
fitrlinear
efficiently trains linear regression models with highdimensional, full or sparse predictor data. Available linear regression models include regularized support vector machines (SVM) and leastsquares regression methods. fitrlinear
minimizes the objective function using techniques that reduce computing time (e.g., stochastic gradient descent).
For reduced computation time on a highdimensional data set that includes many predictor variables, train a linear regression model by using fitrlinear
. For low through mediumdimensional predictor data sets, see Alternatives for LowerDimensional Data.
returns a linear regression model using the predictor variables in the table Mdl
= fitrlinear(Tbl
,ResponseVarName
)Tbl
and the response values in Tbl.ResponseVarName
.
specifies options using one or more namevalue pair arguments in addition to any of the input argument combinations in previous syntaxes. For example, you can specify to crossvalidate, implement leastsquares regression, or specify the type of regularization. A good practice is to crossvalidate using the Mdl
= fitrlinear(X
,Y
,Name,Value
)'Kfold'
namevalue pair argument. The crossvalidation results determine how well the model generalizes.
[
also returns hyperparameter optimization details when you pass an Mdl
,FitInfo
,HyperparameterOptimizationResults
]
= fitrlinear(___)OptimizeHyperparameters
namevalue pair.
Examples
Train Linear Regression Model
Train a linear regression model using SVM, dual SGD, and ridge regularization.
Simulate 10000 observations from this model
$$y={x}_{100}+2{x}_{200}+e.$$
$$X={x}_{1},...,{x}_{1000}$$ is a 10000by1000 sparse matrix with 10% nonzero standard normal elements.
e is random normal error with mean 0 and standard deviation 0.3.
rng(1) % For reproducibility
n = 1e4;
d = 1e3;
nz = 0.1;
X = sprandn(n,d,nz);
Y = X(:,100) + 2*X(:,200) + 0.3*randn(n,1);
Train a linear regression model. By default, fitrlinear
uses support vector machines with a ridge penalty, and optimizes using dual SGD for SVM. Determine how well the optimization algorithm fit the model to the data by extracting a fit summary.
[Mdl,FitInfo] = fitrlinear(X,Y)
Mdl = RegressionLinear ResponseName: 'Y' ResponseTransform: 'none' Beta: [1000x1 double] Bias: 0.0056 Lambda: 1.0000e04 Learner: 'svm' Properties, Methods
FitInfo = struct with fields:
Lambda: 1.0000e04
Objective: 0.2725
PassLimit: 10
NumPasses: 10
BatchLimit: []
NumIterations: 100000
GradientNorm: NaN
GradientTolerance: 0
RelativeChangeInBeta: 0.4907
BetaTolerance: 1.0000e04
DeltaGradient: 1.5816
DeltaGradientTolerance: 0.1000
TerminationCode: 0
TerminationStatus: {'Iteration limit exceeded.'}
Alpha: [10000x1 double]
History: []
FitTime: 0.0331
Solver: {'dual'}
Mdl
is a RegressionLinear
model. You can pass Mdl
and the training or new data to loss
to inspect the insample meansquared error. Or, you can pass Mdl
and new predictor data to predict
to predict responses for new observations.
FitInfo
is a structure array containing, among other things, the termination status (TerminationStatus
) and how long the solver took to fit the model to the data (FitTime
). It is good practice to use FitInfo
to determine whether optimizationtermination measurements are satisfactory. In this case, fitrlinear
reached the maximum number of iterations. Because training time is fast, you can retrain the model, but increase the number of passes through the data. Or, try another solver, such as LBFGS.
Find Good Lasso Penalty Using CrossValidation
To determine a good lassopenalty strength for a linear regression model that uses least squares, implement 5fold crossvalidation.
Simulate 10000 observations from this model
$$y={x}_{100}+2{x}_{200}+e.$$
$$X=\{{x}_{1},...,{x}_{1000}\}$$ is a 10000by1000 sparse matrix with 10% nonzero standard normal elements.
e is random normal error with mean 0 and standard deviation 0.3.
rng(1) % For reproducibility
n = 1e4;
d = 1e3;
nz = 0.1;
X = sprandn(n,d,nz);
Y = X(:,100) + 2*X(:,200) + 0.3*randn(n,1);
Create a set of 15 logarithmicallyspaced regularization strengths from $$1{0}^{5}$$ through $$1{0}^{1}$$.
Lambda = logspace(5,1,15);
Crossvalidate the models. To increase execution speed, transpose the predictor data and specify that the observations are in columns. Optimize the objective function using SpaRSA.
X = X'; CVMdl = fitrlinear(X,Y,'ObservationsIn','columns','KFold',5,'Lambda',Lambda,... 'Learner','leastsquares','Solver','sparsa','Regularization','lasso'); numCLModels = numel(CVMdl.Trained)
numCLModels = 5
CVMdl
is a RegressionPartitionedLinear
model. Because fitrlinear
implements 5fold crossvalidation, CVMdl
contains 5 RegressionLinear
models that the software trains on each fold.
Display the first trained linear regression model.
Mdl1 = CVMdl.Trained{1}
Mdl1 = RegressionLinear ResponseName: 'Y' ResponseTransform: 'none' Beta: [1000x15 double] Bias: [0.0049 0.0049 0.0049 0.0049 0.0049 0.0048 0.0044 0.0037 0.0030 0.0031 0.0033 0.0036 0.0041 0.0051 0.0071] Lambda: [1.0000e05 1.9307e05 3.7276e05 7.1969e05 1.3895e04 2.6827e04 5.1795e04 1.0000e03 0.0019 0.0037 0.0072 0.0139 0.0268 0.0518 0.1000] Learner: 'leastsquares' Properties, Methods
Mdl1
is a RegressionLinear
model object. fitrlinear
constructed Mdl1
by training on the first four folds. Because Lambda
is a sequence of regularization strengths, you can think of Mdl1
as 15 models, one for each regularization strength in Lambda
.
Estimate the crossvalidated MSE.
mse = kfoldLoss(CVMdl);
Higher values of Lambda
lead to predictor variable sparsity, which is a good quality of a regression model. For each regularization strength, train a linear regression model using the entire data set and the same options as when you crossvalidated the models. Determine the number of nonzero coefficients per model.
Mdl = fitrlinear(X,Y,'ObservationsIn','columns','Lambda',Lambda,... 'Learner','leastsquares','Solver','sparsa','Regularization','lasso'); numNZCoeff = sum(Mdl.Beta~=0);
In the same figure, plot the crossvalidated MSE and frequency of nonzero coefficients for each regularization strength. Plot all variables on the log scale.
figure [h,hL1,hL2] = plotyy(log10(Lambda),log10(mse),... log10(Lambda),log10(numNZCoeff)); hL1.Marker = 'o'; hL2.Marker = 'o'; ylabel(h(1),'log_{10} MSE') ylabel(h(2),'log_{10} nonzerocoefficient frequency') xlabel('log_{10} Lambda') hold off
Choose the index of the regularization strength that balances predictor variable sparsity and low MSE (for example, Lambda(10)
).
idxFinal = 10;
Extract the model with corresponding to the minimal MSE.
MdlFinal = selectModels(Mdl,idxFinal)
MdlFinal = RegressionLinear ResponseName: 'Y' ResponseTransform: 'none' Beta: [1000x1 double] Bias: 0.0050 Lambda: 0.0037 Learner: 'leastsquares' Properties, Methods
idxNZCoeff = find(MdlFinal.Beta~=0)
idxNZCoeff = 2×1
100
200
EstCoeff = Mdl.Beta(idxNZCoeff)
EstCoeff = 2×1
1.0051
1.9965
MdlFinal
is a RegressionLinear
model with one regularization strength. The nonzero coefficients EstCoeff
are close to the coefficients that simulated the data.
Optimize a Linear Regression
This example shows how to optimize hyperparameters automatically using fitrlinear
. The example uses artificial (simulated) data for the model
$$y={x}_{100}+2{x}_{200}+e.$$
$$X=\{{x}_{1},...,{x}_{1000}\}$$ is a 10000by1000 sparse matrix with 10% nonzero standard normal elements.
e is random normal error with mean 0 and standard deviation 0.3.
rng(1) % For reproducibility
n = 1e4;
d = 1e3;
nz = 0.1;
X = sprandn(n,d,nz);
Y = X(:,100) + 2*X(:,200) + 0.3*randn(n,1);
Find hyperparameters that minimize fivefold cross validation loss by using automatic hyperparameter optimization.
For reproducibility, use the 'expectedimprovementplus'
acquisition function.
hyperopts = struct('AcquisitionFunctionName','expectedimprovementplus'); [Mdl,FitInfo,HyperparameterOptimizationResults] = fitrlinear(X,Y,... 'OptimizeHyperparameters','auto',... 'HyperparameterOptimizationOptions',hyperopts)
=====================================================================================================  Iter  Eval  Objective:  Objective  BestSoFar  BestSoFar  Lambda  Learner    result  log(1+loss)  runtime  (observed)  (estim.)    =====================================================================================================  1  Best  0.10584  2.0259  0.10584  0.10584  2.4206e09  svm   2  Best  0.10558  1.8363  0.10558  0.1057  0.001807  svm   3  Best  0.10091  0.63106  0.10091  0.10092  2.4681e09  leastsquares   4  Accept  0.11397  0.64009  0.10091  0.10095  0.021027  leastsquares   5  Best  0.10091  0.66748  0.10091  0.10091  2.9697e09  leastsquares   6  Accept  0.45312  1.1135  0.10091  0.10091  9.8803  svm   7  Accept  0.10578  1.3017  0.10091  0.10091  9.6873e06  svm   8  Best  0.1009  0.48068  0.1009  0.10087  1.7286e05  leastsquares   9  Accept  0.44998  0.5347  0.1009  0.10089  9.9615  leastsquares   10  Best  0.10068  0.59687  0.10068  0.10066  0.00081737  leastsquares   11  Accept  0.10582  1.4468  0.10068  0.10065  9.7512e08  svm   12  Accept  0.10091  0.69389  0.10068  0.10084  3.4449e07  leastsquares   13  Accept  0.10575  1.2794  0.10068  0.10085  0.00019667  svm   14  Best  0.10063  0.87715  0.10063  0.10044  0.0038216  leastsquares   15  Accept  0.10091  0.6761  0.10063  0.10086  2.7403e08  leastsquares   16  Accept  0.10091  0.56298  0.10063  0.10088  1.0017e09  leastsquares   17  Accept  0.10091  0.85125  0.10063  0.10089  2.6319e06  leastsquares   18  Accept  0.10584  2.0385  0.10063  0.10089  1.0049e09  svm   19  Accept  0.10087  0.70475  0.10063  0.10089  0.00010789  leastsquares   20  Accept  0.10578  2.2221  0.10063  0.10089  1.0008e06  svm  =====================================================================================================  Iter  Eval  Objective:  Objective  BestSoFar  BestSoFar  Lambda  Learner    result  log(1+loss)  runtime  (observed)  (estim.)    =====================================================================================================  21  Best  0.10052  0.79092  0.10052  0.10024  0.0021701  leastsquares   22  Accept  0.10091  1.1061  0.10052  0.10024  9.8207e08  leastsquares   23  Accept  0.10052  1.1703  0.10052  0.10033  0.0021352  leastsquares   24  Accept  0.10091  1.085  0.10052  0.10033  9.8774e09  leastsquares   25  Accept  0.10052  1.1965  0.10052  0.10038  0.0021099  leastsquares   26  Accept  0.10091  1.1549  0.10052  0.10038  9.351e07  leastsquares   27  Accept  0.31614  1.1273  0.10052  0.10045  0.16873  svm   28  Accept  0.1057  1.5629  0.10052  0.10047  0.00071833  svm   29  Accept  0.10081  0.77057  0.10052  0.10047  0.00030307  leastsquares   30  Accept  0.10091  0.63684  0.10052  0.10047  6.6735e06  leastsquares 
__________________________________________________________ Optimization completed. MaxObjectiveEvaluations of 30 reached. Total function evaluations: 30 Total elapsed time: 62.5361 seconds Total objective function evaluation time: 31.7825 Best observed feasible point: Lambda Learner _________ ____________ 0.0021701 leastsquares Observed objective function value = 0.10052 Estimated objective function value = 0.10047 Function evaluation time = 0.79092 Best estimated feasible point (according to models): Lambda Learner _________ ____________ 0.0021701 leastsquares Estimated objective function value = 0.10047 Estimated function evaluation time = 0.76747
Mdl = RegressionLinear ResponseName: 'Y' ResponseTransform: 'none' Beta: [1000x1 double] Bias: 0.0071 Lambda: 0.0022 Learner: 'leastsquares' Properties, Methods
FitInfo = struct with fields:
Lambda: 0.0022
Objective: 0.0473
IterationLimit: 1000
NumIterations: 15
GradientNorm: 2.4329e06
GradientTolerance: 1.0000e06
RelativeChangeInBeta: 3.3727e05
BetaTolerance: 1.0000e04
DeltaGradient: []
DeltaGradientTolerance: []
TerminationCode: 1
TerminationStatus: {'Tolerance on coefficients satisfied.'}
History: []
FitTime: 0.0492
Solver: {'lbfgs'}
HyperparameterOptimizationResults = BayesianOptimization with properties: ObjectiveFcn: @createObjFcn/inMemoryObjFcn VariableDescriptions: [3x1 optimizableVariable] Options: [1x1 struct] MinObjective: 0.1005 XAtMinObjective: [1x2 table] MinEstimatedObjective: 0.1005 XAtMinEstimatedObjective: [1x2 table] NumObjectiveEvaluations: 30 TotalElapsedTime: 62.5361 NextPoint: [1x2 table] XTrace: [30x2 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]
This optimization technique is simpler than that shown in Find Good Lasso Penalty Using CrossValidation, but does not allow you to trade off model complexity and crossvalidation loss.
Input Arguments
X
— Predictor data
full matrix  sparse matrix
Predictor data, specified as an nbyp full or sparse matrix.
The length of Y
and the number of observations
in X
must be equal.
Note
If you orient your predictor matrix so that observations correspond to columns and
specify 'ObservationsIn','columns'
, then you might experience a
significant reduction in optimization execution time.
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 inTbl
as predictors, then specify the response variable by usingResponseVarName
.If
Tbl
contains the response variable, and you want to use only a subset of the remaining variables inTbl
as predictors, then specify a formula by usingformula
.If
Tbl
does not contain the response variable, then specify a response variable by usingY
. The length of the response variable and the number of rows inTbl
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 (for example,
Y
orValidationData
{2}
)At least one missing value in a predictor observation (for example, row in
X
orValidationData{1}
)NaN
value or0
weight (for example, value inWeights
orValidationData{3}
)
For memoryusage economy, it is best practice to remove observations containing missing values from your training data manually before training.
NameValue Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Namevalue arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: Mdl = fitrlinear(X,Y,'Learner','leastsquares','CrossVal','on','Regularization','lasso')
specifies to implement leastsquares regression, implement 10fold crossvalidation, and specifies to include a lasso regularization term.
Note
You cannot use any crossvalidation namevalue argument together with the
'OptimizeHyperparameters'
namevalue argument. You can modify the
crossvalidation for 'OptimizeHyperparameters'
only by using the
'HyperparameterOptimizationOptions'
namevalue argument.
Epsilon
— Half the width of epsiloninsensitive band
iqr(Y)/13.49
(default)  nonnegative scalar value
Half the width of the epsiloninsensitive band, specified as the commaseparated pair consisting of 'Epsilon'
and a nonnegative scalar value. 'Epsilon'
applies to SVM learners only.
The default Epsilon
value is iqr(Y)/13.49
, which is an estimate of standard deviation using the interquartile range of the response variable Y
. If iqr(Y)
is equal to zero, then the default Epsilon
value is 0.1.
Example: 'Epsilon',0.3
Data Types: single
 double
Lambda
— Regularization term strength
'auto'
(default)  nonnegative scalar  vector of nonnegative values
Regularization term strength, specified as the commaseparated pair consisting of 'Lambda'
and 'auto'
, a nonnegative scalar, or a vector of nonnegative values.
For
'auto'
,Lambda
= 1/n.If you specify a crossvalidation, namevalue pair argument (e.g.,
CrossVal
), then n is the number of infold observations.Otherwise, n is the training sample size.
For a vector of nonnegative values,
fitrlinear
sequentially optimizes the objective function for each distinct value inLambda
in ascending order.If
Solver
is'sgd'
or'asgd'
andRegularization
is'lasso'
,fitrlinear
does not use the previous coefficient estimates as a warm start for the next optimization iteration. Otherwise,fitrlinear
uses warm starts.If
Regularization
is'lasso'
, then any coefficient estimate of 0 retains its value whenfitrlinear
optimizes using subsequent values inLambda
.fitrlinear
returns coefficient estimates for each specified regularization strength.
Example: 'Lambda',10.^((10:2:2))
Data Types: char
 string
 double
 single
Learner
— Linear regression model type
'svm'
(default)  'leastsquares'
Linear regression model type, specified as the commaseparated pair consisting of 'Learner'
and 'svm'
or 'leastsquares'
.
In this table, $$f\left(x\right)=x\beta +b.$$
β is a vector of p coefficients.
x is an observation from p predictor variables.
b is the scalar bias.
Value  Algorithm  Response range  Loss function 

'leastsquares'  Linear regression via ordinary least squares  y ∊ (∞,∞)  Mean squared error (MSE): $$\ell \left[y,f\left(x\right)\right]=\frac{1}{2}{\left[yf\left(x\right)\right]}^{2}$$ 
'svm'  Support vector machine regression  Same as 'leastsquares'  Epsiloninsensitive: $$\ell \left[y,f\left(x\right)\right]=\mathrm{max}\left[0,\leftyf\left(x\right)\right\epsilon \right]$$ 
Example: 'Learner','leastsquares'
ObservationsIn
— Predictor data observation dimension
'rows'
(default)  'columns'
Predictor data observation dimension, specified as 'rows'
or
'columns'
.
Note
If you orient your predictor matrix so that observations correspond to columns and
specify 'ObservationsIn','columns'
, then you might experience a
significant reduction in computation time. You cannot specify
'ObservationsIn','columns'
for predictor data in a
table.
Example: 'ObservationsIn','columns'
Data Types: char
 string
Regularization
— Complexity penalty type
'lasso'
 'ridge'
Complexity penalty type, specified as the commaseparated pair
consisting of 'Regularization'
and 'lasso'
or 'ridge'
.
The software composes the objective function for minimization
from the sum of the average loss function (see Learner
)
and the regularization term in this table.
Value  Description 

'lasso'  Lasso (L1) penalty: $$\lambda {\displaystyle \sum _{j=1}^{p}\left{\beta}_{j}\right}$$ 
'ridge'  Ridge (L2) penalty: $$\frac{\lambda}{2}{\displaystyle \sum _{j=1}^{p}{\beta}_{j}^{2}}$$ 
To specify the regularization term strength, which is λ in
the expressions, use Lambda
.
The software excludes the bias term (β_{0}) from the regularization penalty.
If Solver
is 'sparsa'
,
then the default value of Regularization
is 'lasso'
.
Otherwise, the default is 'ridge'
.
Tip
For predictor variable selection, specify
'lasso'
. For more on variable selection, see Introduction to Feature Selection.For optimization accuracy, specify
'ridge'
.
Example: 'Regularization','lasso'
Solver
— Objective function minimization technique
'sgd'
 'asgd'
 'dual'
 'bfgs'
 'lbfgs'
 'sparsa'
 string array  cell array of character vectors
Objective function minimization technique, specified as the commaseparated pair consisting of 'Solver'
and a character vector or string scalar, a string array, or a cell array of character vectors with values from this table.
Value  Description  Restrictions 

'sgd'  Stochastic gradient descent (SGD) [5][3]  
'asgd'  Average stochastic gradient descent (ASGD) [8]  
'dual'  Dual SGD for SVM [2][7]  Regularization must be 'ridge' and Learner must be 'svm' . 
'bfgs'  BroydenFletcherGoldfarbShanno quasiNewton algorithm (BFGS) [4]  Inefficient if X is very highdimensional. 
'lbfgs'  Limitedmemory BFGS (LBFGS) [4]  Regularization must be 'ridge' . 
'sparsa'  Sparse Reconstruction by Separable Approximation (SpaRSA) [6]  Regularization must be 'lasso' . 
If you specify:
A ridge penalty (see
Regularization
) andsize(X,1) <= 100
(100 or fewer predictor variables), then the default solver is'bfgs'
.An SVM regression model (see
Learner
), a ridge penalty, andsize(X,1) > 100
(more than 100 predictor variables), then the default solver is'dual'
.A lasso penalty and
X
contains 100 or fewer predictor variables, then the default solver is'sparsa'
.
Otherwise, the default solver is
'sgd'
. Note that the default solver can change when
you perform hyperparameter optimization. For more information, see Regularization method determines the solver used during hyperparameter optimization.
If you specify a string array or cell array of solver names, then, for
each value in Lambda
, the software uses the
solutions of solver j as a warm start for solver
j + 1.
Example: {'sgd' 'lbfgs'}
applies SGD to solve the
objective, and uses the solution as a warm start for
LBFGS.
Tip
SGD and ASGD can solve the objective function more quickly than other solvers, whereas LBFGS and SpaRSA can yield more accurate solutions than other solvers. Solver combinations like
{'sgd' 'lbfgs'}
and{'sgd' 'sparsa'}
can balance optimization speed and accuracy.When choosing between SGD and ASGD, consider that:
SGD takes less time per iteration, but requires more iterations to converge.
ASGD requires fewer iterations to converge, but takes more time per iteration.
If the predictor data is high dimensional and
Regularization
is'ridge'
, setSolver
to any of these combinations:'sgd'
'asgd'
'dual'
ifLearner
is'svm'
'lbfgs'
{'sgd','lbfgs'}
{'asgd','lbfgs'}
{'dual','lbfgs'}
ifLearner
is'svm'
Although you can set other combinations, they often lead to solutions with poor accuracy.
If the predictor data is moderate through low dimensional and
Regularization
is'ridge'
, setSolver
to'bfgs'
.If
Regularization
is'lasso'
, setSolver
to any of these combinations:'sgd'
'asgd'
'sparsa'
{'sgd','sparsa'}
{'asgd','sparsa'}
Example: 'Solver',{'sgd','lbfgs'}
Beta
— Initial linear coefficient estimates
zeros(p
,1)
(default)  numeric vector  numeric matrix
p
,1)Initial linear coefficient estimates (β),
specified as the commaseparated pair consisting of 'Beta'
and
a pdimensional numeric vector or a pbyL numeric
matrix. p is the number of predictor variables
in X
and L is the number of
regularizationstrength values (for more details, see Lambda
).
If you specify a pdimensional vector, then the software optimizes the objective function L times using this process.
The software optimizes using
Beta
as the initial value and the minimum value ofLambda
as the regularization strength.The software optimizes again using the resulting estimate from the previous optimization as a warm start, and the next smallest value in
Lambda
as the regularization strength.The software implements step 2 until it exhausts all values in
Lambda
.
If you specify a pbyL matrix, then the software optimizes the objective function L times. At iteration
j
, the software usesBeta(:,
as the initial value and, after it sortsj
)Lambda
in ascending order, usesLambda(
as the regularization strength.j
)
If you set 'Solver','dual'
, then the software
ignores Beta
.
Data Types: single
 double
Bias
— Initial intercept estimate
numeric scalar  numeric vector
Initial intercept estimate (b), specified as the commaseparated pair consisting of 'Bias'
and a numeric scalar or an Ldimensional numeric vector. L is the number of regularizationstrength values (for more details, see Lambda
).
If you specify a scalar, then the software optimizes the objective function L times using this process.
The software optimizes using
Bias
as the initial value and the minimum value ofLambda
as the regularization strength.The uses the resulting estimate as a warm start to the next optimization iteration, and uses the next smallest value in
Lambda
as the regularization strength.The software implements step 2 until it exhausts all values in
Lambda
.
If you specify an Ldimensional vector, then the software optimizes the objective function L times. At iteration
j
, the software usesBias(
as the initial value and, after it sortsj
)Lambda
in ascending order, usesLambda(
as the regularization strength.j
)By default:
Data Types: single
 double
FitBias
— Linear model intercept inclusion flag
true
(default)  false
Linear model intercept inclusion flag, specified as the commaseparated
pair consisting of 'FitBias'
and true
or false
.
Value  Description 

true  The software includes the bias term b in the linear model, and then estimates it. 
false  The software sets b = 0 during estimation. 
Example: 'FitBias',false
Data Types: logical
PostFitBias
— Flag to fit linear model intercept after optimization
false
(default)  true
Flag to fit the linear model intercept after optimization, specified as the commaseparated pair consisting of 'PostFitBias'
and true
or false
.
Value  Description 

false  The software estimates the bias term b and the coefficients β during optimization. 
true  To estimate b, the software:

If you specify true
, then FitBias
must be true.
Example: 'PostFitBias',true
Data Types: logical
Verbose
— Verbosity level
0
(default)  nonnegative integer
Verbosity level, specified as the commaseparated pair consisting
of 'Verbose'
and a nonnegative integer. Verbose
controls
the amount of diagnostic information fitrlinear
displays
at the command line.
Value  Description 

0  fitrlinear does not display diagnostic
information. 
1  fitrlinear periodically displays and
stores the value of the objective function, gradient magnitude, and
other diagnostic information. FitInfo.History contains
the diagnostic information. 
Any other positive integer  fitrlinear displays and stores diagnostic
information at each optimization iteration. FitInfo.History contains
the diagnostic information. 
Example: 'Verbose',1
Data Types: double
 single
BatchSize
— Minibatch size
positive integer
Minibatch size, specified as the commaseparated pair consisting
of 'BatchSize'
and a positive integer. At each
iteration, the software estimates the subgradient using BatchSize
observations
from the training data.
If
X
is a numeric matrix, then the default value is10
.If
X
is a sparse matrix, then the default value ismax([10,ceil(sqrt(ff))])
, whereff = numel(X)/nnz(X)
(the fullness factor ofX
).
Example: 'BatchSize',100
Data Types: single
 double
LearnRate
— Learning rate
positive scalar
Learning rate, specified as the commaseparated pair consisting of 'LearnRate'
and a positive scalar. LearnRate
specifies how many steps to take per iteration. At each iteration, the gradient specifies the direction and magnitude of each step.
If
Regularization
is'ridge'
, thenLearnRate
specifies the initial learning rate γ_{0}. The software determines the learning rate for iteration t, γ_{t}, using$${\gamma}_{t}=\frac{{\gamma}_{0}}{{\left(1+\lambda {\gamma}_{0}t\right)}^{c}}.$$
If
Regularization
is'lasso'
, then, for all iterations,LearnRate
is constant.
By default, LearnRate
is 1/sqrt(1+max((sum(X.^2,obsDim))))
, where obsDim
is 1
if the observations compose the columns of X
, and 2
otherwise.
Example: 'LearnRate',0.01
Data Types: single
 double
OptimizeLearnRate
— Flag to decrease learning rate
true
(default)  false
Flag to decrease the learning rate when the software detects
divergence (that is, overstepping the minimum), specified as the
commaseparated pair consisting of 'OptimizeLearnRate'
and true
or false
.
If OptimizeLearnRate
is 'true'
,
then:
For the few optimization iterations, the software starts optimization using
LearnRate
as the learning rate.If the value of the objective function increases, then the software restarts and uses half of the current value of the learning rate.
The software iterates step 2 until the objective function decreases.
Example: 'OptimizeLearnRate',true
Data Types: logical
TruncationPeriod
— Number of minibatches between lasso truncation runs
10
(default)  positive integer
Number of minibatches between lasso truncation runs, specified
as the commaseparated pair consisting of 'TruncationPeriod'
and
a positive integer.
After a truncation run, the software applies a soft threshold
to the linear coefficients. That is, after processing k = TruncationPeriod
minibatches,
the software truncates the estimated coefficient j using
$${\widehat{\beta}}_{j}^{\ast}=\{\begin{array}{ll}{\widehat{\beta}}_{j}{u}_{t}\hfill & \text{if}\text{\hspace{0.17em}}{\widehat{\beta}}_{j}>{u}_{t},\hfill \\ 0\hfill & \text{if}\text{\hspace{0.17em}}\left{\widehat{\beta}}_{j}\right\le {u}_{t},\hfill \\ {\widehat{\beta}}_{j}+{u}_{t}\hfill & \text{if}\text{\hspace{0.17em}}{\widehat{\beta}}_{j}<{u}_{t}.\hfill \end{array}\begin{array}{r}\hfill \text{\hspace{0.17em}}\text{\hspace{0.17em}}\\ \hfill \text{\hspace{0.17em}}\text{\hspace{0.17em}}\\ \hfill \text{\hspace{0.17em}}\text{\hspace{0.17em}}\end{array}$$
For SGD, $${\widehat{\beta}}_{j}$$ is the estimate of coefficient j after processing k minibatches. $${u}_{t}=k{\gamma}_{t}\lambda .$$ γ_{t} is the learning rate at iteration t. λ is the value of
Lambda
.For ASGD, $${\widehat{\beta}}_{j}$$ is the averaged estimate coefficient j after processing k minibatches, $${u}_{t}=k\lambda .$$
If Regularization
is 'ridge'
,
then the software ignores TruncationPeriod
.
Example: 'TruncationPeriod',100
Data Types: single
 double
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. The descriptions assume that the predictor data has observations in rows and predictors in columns.
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 If 
Logical vector 
A 
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
), fitrlinear
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
), fitrlinear
assumes that all predictors are
continuous. To identify any other predictors as categorical predictors, specify them by using
the CategoricalPredictors
namevalue argument.
For the identified categorical predictors, fitrlinear
creates
dummy variables using two different schemes, depending on whether a categorical variable
is unordered or ordered. For an unordered categorical variable,
fitrlinear
creates one dummy variable for each level of the
categorical variable. For an ordered categorical variable,
fitrlinear
creates one less dummy variable than the number of
categories. For details, see Automatic Creation of Dummy Variables.
Example: 'CategoricalPredictors','all'
Data Types: single
 double
 logical
 char
 string
 cell
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
andY
, then you can use'PredictorNames'
to assign names to the predictor variables inX
.The order of the names in
PredictorNames
must correspond to the predictor order inX
. Assuming thatX
has the default orientation, with observations in rows and predictors in columns,PredictorNames{1}
is the name ofX(:,1)
,PredictorNames{2}
is the name ofX(:,2)
, and so on. Also,size(X,2)
andnumel(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,fitrlinear
uses only the predictor variables inPredictorNames
and the response variable during training.PredictorNames
must be a subset ofTbl.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'
orformula
, 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 useResponseName
to specify a name for the response variable.If you supply
ResponseVarName
orformula
, then you cannot useResponseName
.
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
positive numeric vector  name of variable in Tbl
Observation weights, specified as the commaseparated pair consisting of 'Weights'
and a positive numeric vector or the name of a variable in Tbl
. The software weights each observation in X
or Tbl
with the corresponding value in Weights
. The length of Weights
must equal the number of observations 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
.
fitrlinear
normalizes the weights to sum to 1.
Data Types: single
 double
 char
 string
CrossVal
— Crossvalidation flag
'off'
(default)  'on'
Crossvalidation flag, specified as the commaseparated pair
consisting of 'Crossval'
and 'on'
or 'off'
.
If you specify 'on'
, then the software implements
10fold crossvalidation.
To override this crossvalidation setting, use one of these
namevalue pair arguments: CVPartition
, Holdout
,
or KFold
. To create a crossvalidated model,
you can use one crossvalidation namevalue pair argument at a time
only.
Example: 'Crossval','on'
CVPartition
— Crossvalidation partition
[]
(default)  cvpartition
partition object
Crossvalidation partition, specified as the commaseparated
pair consisting of 'CVPartition'
and a cvpartition
partition
object as created by cvpartition
.
The partition object specifies the type of crossvalidation, and also
the indexing for training and validation sets.
To create a crossvalidated model, you can use one of these
four options only: '
CVPartition
'
, '
Holdout
'
,
or '
KFold
'
.
Holdout
— Fraction of data for holdout validation
scalar value in the range (0,1)
Fraction of data used for holdout validation, specified as the
commaseparated pair consisting of 'Holdout'
and
a scalar value in the range (0,1). If you specify 'Holdout',
,
then the software: p
Randomly reserves
% of the data as validation data, and trains the model using the rest of the datap
*100Stores the compact, trained model in the
Trained
property of the crossvalidated model.
To create a crossvalidated model, you can use one of these
four options only: '
CVPartition
'
, '
Holdout
'
,
or '
KFold
'
.
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 a crossvalidated classifier, specified
as the commaseparated pair consisting of 'KFold'
and
a positive integer value greater than 1. If you specify, e.g., 'KFold',k
,
then the software:
Randomly partitions the data into k sets
For each set, reserves the set as validation data, and trains the model using the other k – 1 sets
Stores the
k
compact, trained models in the cells of ak
by1 cell vector in theTrained
property of the crossvalidated model.
To create a crossvalidated model, you can use one of these
four options only: '
CVPartition
'
, '
Holdout
'
,
or '
KFold
'
.
Example: 'KFold',8
Data Types: single
 double
BatchLimit
— Maximal number of batches
positive integer
Maximal number of batches to process, specified as the commaseparated
pair consisting of 'BatchLimit'
and a positive
integer. When the software processes BatchLimit
batches,
it terminates optimization.
By default:
If you specify
BatchLimit
, thenfitrlinear
uses the argument that results in processing the fewest observations, eitherBatchLimit
orPassLimit
.
Example: 'BatchLimit',100
Data Types: single
 double
BetaTolerance
— Relative tolerance on linear coefficients and bias term
1e4
(default)  nonnegative scalar
Relative tolerance on the linear coefficients and the bias term (intercept), specified
as the commaseparated pair consisting of 'BetaTolerance'
and a
nonnegative scalar.
Let $${B}_{t}=\left[{\beta}_{t}{}^{\prime}\text{\hspace{0.17em}}\text{\hspace{0.17em}}{b}_{t}\right]$$, that is, the vector of the coefficients and the bias term at optimization iteration t. If $${\Vert \frac{{B}_{t}{B}_{t1}}{{B}_{t}}\Vert}_{2}<\text{BetaTolerance}$$, then optimization terminates.
If the software converges for the last solver specified in
Solver
, then optimization terminates. Otherwise, the software uses
the next solver specified in Solver
.
Example: 'BetaTolerance',1e6
Data Types: single
 double
NumCheckConvergence
— Number of batches to process before next convergence check
positive integer
Number of batches to process before next convergence check, specified as the
commaseparated pair consisting of 'NumCheckConvergence'
and a
positive integer.
To specify the batch size, see BatchSize
.
The software checks for convergence about 10 times per pass through the entire data set by default.
Example: 'NumCheckConvergence',100
Data Types: single
 double
PassLimit
— Maximal number of passes
1
(default)  positive integer
Maximal number of passes through the data, specified as the commaseparated pair consisting of 'PassLimit'
and a positive integer.
fitrlinear
processes all observations when it completes one pass through the data.
When fitrlinear
passes through the data PassLimit
times, it terminates optimization.
If you specify BatchLimit
, then
fitrlinear
uses the argument that results in
processing the fewest observations, either
BatchLimit
or PassLimit
.
For more details, see Algorithms.
Example: 'PassLimit',5
Data Types: single
 double
ValidationData
— Validation data for optimization convergence detection
cell array  table
Validation data for optimization convergence detection, specified as the commaseparated pair
consisting of 'ValidationData'
and a cell array or table.
During optimization, the software periodically estimates the loss of ValidationData
. If the validationdata loss increases, then the software terminates optimization. For more details, see Algorithms. To optimize hyperparameters using crossvalidation, see crossvalidation options such as CrossVal
.
You can specify ValidationData
as a table if you use a table
Tbl
of predictor data that contains the response variable. In this
case, ValidationData
must contain the same predictors and response
contained in Tbl
. The software does not apply weights to observations,
even if Tbl
contains a vector of weights. To specify weights, you must
specify ValidationData
as a cell array.
If you specify ValidationData
as a cell array, then it must have the
following format:
ValidationData{1}
must have the same data type and orientation as the predictor data. That is, if you use a predictor matrixX
, thenValidationData{1}
must be an mbyp or pbym full or sparse matrix of predictor data that has the same orientation asX
. The predictor variables in the training dataX
andValidationData{1}
must correspond. Similarly, if you use a predictor tableTbl
of predictor data, thenValidationData{1}
must be a table containing the same predictor variables contained inTbl
. The number of observations inValidationData{1}
and the predictor data can vary.ValidationData{2}
must match the data type and format of the response variable, eitherY
orResponseVarName
. IfValidationData{2}
is an array of responses, then it must have the same number of elements as the number of observations inValidationData{1}
. IfValidationData{1}
is a table, thenValidationData{2}
can be the name of the response variable in the table. If you want to use the sameResponseVarName
orformula
, you can specifyValidationData{2}
as[]
.Optionally, you can specify
ValidationData{3}
as an mdimensional numeric vector of observation weights or the name of a variable in the tableValidationData{1}
that contains observation weights. The software normalizes the weights with the validation data so that they sum to 1.
If you specify ValidationData
and want to display the validation loss at
the command line, specify a value larger than 0 for Verbose
.
If the software converges for the last solver specified in Solver
, then optimization terminates. Otherwise, the software uses the next solver specified in Solver
.
By default, the software does not detect convergence by monitoring validationdata loss.
GradientTolerance
— Absolute gradient tolerance
1e6
(default)  nonnegative scalar
Absolute gradient tolerance, specified as the commaseparated pair consisting of 'GradientTolerance'
and a nonnegative scalar. GradientTolerance
applies to these values of Solver
: 'bfgs'
, 'lbfgs'
, and 'sparsa'
.
Let $$\nabla {\mathcal{L}}_{t}$$ be the gradient vector of the objective function with respect to the coefficients and bias term at optimization iteration t. If $${\Vert \nabla {\mathcal{L}}_{t}\Vert}_{\infty}=\mathrm{max}\left\nabla {\mathcal{L}}_{t}\right<\text{GradientTolerance}$$, then optimization terminates.
If you also specify BetaTolerance
, then optimization terminates when fitrlinear
satisfies either stopping criterion.
If fitrlinear
converges for the last solver specified in Solver
, then optimization terminates. Otherwise, fitrlinear
uses the next solver specified in Solver
.
Example: 'GradientTolerance',eps
Data Types: single
 double
IterationLimit
— Maximal number of optimization iterations
1000
(default)  positive integer
Maximal number of optimization iterations, specified as the commaseparated pair consisting of 'IterationLimit'
and a positive integer. IterationLimit
applies to these values of Solver
: 'bfgs'
, 'lbfgs'
, and 'sparsa'
.
Example: 'IterationLimit',1e7
Data Types: single
 double
BetaTolerance
— Relative tolerance on linear coefficients and bias term
1e4
(default)  nonnegative scalar
Relative tolerance on the linear coefficients and the bias term (intercept), specified
as the commaseparated pair consisting of 'BetaTolerance'
and a
nonnegative scalar.
Let $${B}_{t}=\left[{\beta}_{t}{}^{\prime}\text{\hspace{0.17em}}\text{\hspace{0.17em}}{b}_{t}\right]$$, that is, the vector of the coefficients and the bias term at optimization iteration t. If $${\Vert \frac{{B}_{t}{B}_{t1}}{{B}_{t}}\Vert}_{2}<\text{BetaTolerance}$$, then optimization terminates.
If you also specify DeltaGradientTolerance
, then optimization
terminates when the software satisfies either stopping criterion.
If the software converges for the last solver specified in
Solver
, then optimization terminates. Otherwise, the software uses
the next solver specified in Solver
.
Example: 'BetaTolerance',1e6
Data Types: single
 double
DeltaGradientTolerance
— Gradientdifference tolerance
0.1
(default)  nonnegative scalar
Gradientdifference tolerance between upper and lower pool KarushKuhnTucker
(KKT) complementarity conditions violators, specified as a
nonnegative scalar. DeltaGradientTolerance
applies to
the 'dual'
value of Solver
only.
If the magnitude of the KKT violators is less than
DeltaGradientTolerance
, thenfitrlinear
terminates optimization.If
fitrlinear
converges for the last solver specified inSolver
, then optimization terminates. Otherwise,fitrlinear
uses the next solver specified inSolver
.
Example: 'DeltaGradientTolerance',1e2
Data Types: double
 single
NumCheckConvergence
— Number of passes through entire data set to process before next convergence check
5
(default)  positive integer
Number of passes through entire data set to process before next convergence check,
specified as the commaseparated pair consisting of
'NumCheckConvergence'
and a positive integer.
Example: 'NumCheckConvergence',100
Data Types: single
 double
PassLimit
— Maximal number of passes
10
(default)  positive integer
Maximal number of passes through the data, specified as the
commaseparated pair consisting of 'PassLimit'
and
a positive integer.
When the software completes one pass through the data, it has processed all observations.
When the software passes through the data PassLimit
times,
it terminates optimization.
Example: 'PassLimit',5
Data Types: single
 double
ValidationData
— Validation data for optimization convergence detection
cell array  table
Validation data for optimization convergence detection, specified as the commaseparated pair
consisting of 'ValidationData'
and a cell array or table.
During optimization, the software periodically estimates the loss of ValidationData
. If the validationdata loss increases, then the software terminates optimization. For more details, see Algorithms. To optimize hyperparameters using crossvalidation, see crossvalidation options such as CrossVal
.
You can specify ValidationData
as a table if you use a table
Tbl
of predictor data that contains the response variable. In this
case, ValidationData
must contain the same predictors and response
contained in Tbl
. The software does not apply weights to observations,
even if Tbl
contains a vector of weights. To specify weights, you must
specify ValidationData
as a cell array.
If you specify ValidationData
as a cell array, then it must have the
following format:
ValidationData{1}
must have the same data type and orientation as the predictor data. That is, if you use a predictor matrixX
, thenValidationData{1}
must be an mbyp or pbym full or sparse matrix of predictor data that has the same orientation asX
. The predictor variables in the training dataX
andValidationData{1}
must correspond. Similarly, if you use a predictor tableTbl
of predictor data, thenValidationData{1}
must be a table containing the same predictor variables contained inTbl
. The number of observations inValidationData{1}
and the predictor data can vary.ValidationData{2}
must match the data type and format of the response variable, eitherY
orResponseVarName
. IfValidationData{2}
is an array of responses, then it must have the same number of elements as the number of observations inValidationData{1}
. IfValidationData{1}
is a table, thenValidationData{2}
can be the name of the response variable in the table. If you want to use the sameResponseVarName
orformula
, you can specifyValidationData{2}
as[]
.Optionally, you can specify
ValidationData{3}
as an mdimensional numeric vector of observation weights or the name of a variable in the tableValidationData{1}
that contains observation weights. The software normalizes the weights with the validation data so that they sum to 1.
If you specify ValidationData
and want to display the validation loss at
the command line, specify a value larger than 0 for Verbose
.
If the software converges for the last solver specified in Solver
, then optimization terminates. Otherwise, the software uses the next solver specified in Solver
.
By default, the software does not detect convergence by monitoring validationdata loss.
BetaTolerance
— Relative tolerance on linear coefficients and bias term
1e4
(default)  nonnegative scalar
Relative tolerance on the linear coefficients and the bias term (intercept), specified as a nonnegative scalar.
Let $${B}_{t}=\left[{\beta}_{t}{}^{\prime}\text{\hspace{0.17em}}\text{\hspace{0.17em}}{b}_{t}\right]$$, that is, the vector of the coefficients and the bias term at optimization iteration t. If $${\Vert \frac{{B}_{t}{B}_{t1}}{{B}_{t}}\Vert}_{2}<\text{BetaTolerance}$$, then optimization terminates.
If you also specify GradientTolerance
, then optimization terminates when the software satisfies either stopping criterion.
If the software converges for the last solver specified in
Solver
, then optimization terminates. Otherwise, the software uses
the next solver specified in Solver
.
Example: 'BetaTolerance',1e6
Data Types: single
 double
GradientTolerance
— Absolute gradient tolerance
1e6
(default)  nonnegative scalar
Absolute gradient tolerance, specified as a nonnegative scalar.
Let $$\nabla {\mathcal{L}}_{t}$$ be the gradient vector of the objective function with respect to the coefficients and bias term at optimization iteration t. If $${\Vert \nabla {\mathcal{L}}_{t}\Vert}_{\infty}=\mathrm{max}\left\nabla {\mathcal{L}}_{t}\right<\text{GradientTolerance}$$, then optimization terminates.
If you also specify BetaTolerance
, then optimization terminates when the
software satisfies either stopping criterion.
If the software converges for the last solver specified in the
software, then optimization terminates. Otherwise, the software uses
the next solver specified in Solver
.
Example: 'GradientTolerance',1e5
Data Types: single
 double
HessianHistorySize
— Size of history buffer for Hessian approximation
15
(default)  positive integer
Size of history buffer for Hessian approximation, specified
as the commaseparated pair consisting of 'HessianHistorySize'
and
a positive integer. That is, at each iteration, the software composes
the Hessian using statistics from the latest HessianHistorySize
iterations.
The software does not support 'HessianHistorySize'
for
SpaRSA.
Example: 'HessianHistorySize',10
Data Types: single
 double
IterationLimit
— Maximal number of optimization iterations
1000
(default)  positive integer
Maximal number of optimization iterations, specified as the
commaseparated pair consisting of 'IterationLimit'
and
a positive integer. IterationLimit
applies to these
values of Solver
: 'bfgs'
, 'lbfgs'
,
and 'sparsa'
.
Example: 'IterationLimit',500
Data Types: single
 double
ValidationData
— Validation data for optimization convergence detection
cell array  table
Validation data for optimization convergence detection, specified as the commaseparated pair
consisting of 'ValidationData'
and a cell array or table.
During optimization, the software periodically estimates the loss of ValidationData
. If the validationdata loss increases, then the software terminates optimization. For more details, see Algorithms. To optimize hyperparameters using crossvalidation, see crossvalidation options such as CrossVal
.
You can specify ValidationData
as a table if you use a table
Tbl
of predictor data that contains the response variable. In this
case, ValidationData
must contain the same predictors and response
contained in Tbl
. The software does not apply weights to observations,
even if Tbl
contains a vector of weights. To specify weights, you must
specify ValidationData
as a cell array.
If you specify ValidationData
as a cell array, then it must have the
following format:
ValidationData{1}
must have the same data type and orientation as the predictor data. That is, if you use a predictor matrixX
, thenValidationData{1}
must be an mbyp or pbym full or sparse matrix of predictor data that has the same orientation asX
. The predictor variables in the training dataX
andValidationData{1}
must correspond. Similarly, if you use a predictor tableTbl
of predictor data, thenValidationData{1}
must be a table containing the same predictor variables contained inTbl
. The number of observations inValidationData{1}
and the predictor data can vary.ValidationData{2}
must match the data type and format of the response variable, eitherY
orResponseVarName
. IfValidationData{2}
is an array of responses, then it must have the same number of elements as the number of observations inValidationData{1}
. IfValidationData{1}
is a table, thenValidationData{2}
can be the name of the response variable in the table. If you want to use the sameResponseVarName
orformula
, you can specifyValidationData{2}
as[]
.Optionally, you can specify
ValidationData{3}
as an mdimensional numeric vector of observation weights or the name of a variable in the tableValidationData{1}
that contains observation weights. The software normalizes the weights with the validation data so that they sum to 1.
If you specify ValidationData
and want to display the validation loss at
the command line, specify a value larger than 0 for Verbose
.
If the software converges for the last solver specified in Solver
, then optimization terminates. Otherwise, the software uses the next solver specified in Solver
.
By default, the software does not detect convergence by monitoring validationdata loss.
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 commaseparated pair consisting of 'OptimizeHyperparameters'
and one of the following:
'none'
— Do not optimize.'auto'
— Use{'Lambda','Learner'}
.'all'
— Optimize all eligible parameters.String array or cell array of eligible parameter names.
Vector of
optimizableVariable
objects, typically the output ofhyperparameters
.
The optimization attempts to minimize the crossvalidation loss (error) for fitrlinear
by varying the parameters. To control the crossvalidation type and other aspects of the optimization, use the HyperparameterOptimizationOptions
namevalue pair.
Note
The values of 'OptimizeHyperparameters'
override any values you specify
using other namevalue arguments. For example, setting
'OptimizeHyperparameters'
to 'auto'
causes
fitrlinear
to optimize hyperparameters corresponding to the
'auto'
option and to ignore any specified values for the
hyperparameters.
The eligible parameters for fitrlinear
are:
Lambda
—fitrlinear
searches among positive values, by default logscaled in the range[1e5/NumObservations,1e5/NumObservations]
.Learner
—fitrlinear
searches among'svm'
and'leastsquares'
.Regularization
—fitrlinear
searches among'ridge'
and'lasso'
.When
Regularization
is'ridge'
, the function sets theSolver
value to'lbfgs'
by default.When
Regularization
is'lasso'
, the function sets theSolver
value to'sparsa'
by default.
Set nondefault parameters by passing a vector of optimizableVariable
objects that have nondefault values. For example,
load carsmall params = hyperparameters('fitrlinear',[Horsepower,Weight],MPG); params(1).Range = [1e3,2e4];
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 + crossvalidation loss). To control the iterative display, set the Verbose
field of
the 'HyperparameterOptimizationOptions'
namevalue argument. To control the
plots, set the ShowPlots
field of the
'HyperparameterOptimizationOptions'
namevalue argument.
For an example, see Optimize a Linear Regression.
Example: 'OptimizeHyperparameters','auto'
HyperparameterOptimizationOptions
— Options for optimization
structure
Options for optimization, specified as a structure. This argument modifies the effect of the
OptimizeHyperparameters
namevalue argument. All fields in the
structure are optional.
Field Name  Values  Default 

Optimizer 
 'bayesopt' 
AcquisitionFunctionName 
Acquisition functions whose names include
 'expectedimprovementpersecondplus' 
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  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:
For details, see the  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 crossvalidation at every
iteration. If this field is The setting
 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 crossvalidation
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
Mdl
— Trained linear regression model
RegressionLinear
model object  RegressionPartitionedLinear
crossvalidated model object
Trained linear regression model, returned as a RegressionLinear
model object or RegressionPartitionedLinear
crossvalidated model object.
If you set any of the namevalue pair arguments KFold
, Holdout
, CrossVal
, or CVPartition
, then Mdl
is a RegressionPartitionedLinear
crossvalidated model object. Otherwise, Mdl
is a RegressionLinear
model object.
To reference properties of Mdl
, use dot notation. For example, enter Mdl.Beta
in the Command Window to display the vector or matrix of estimated coefficients.
Note
Unlike other regression models, and for economical memory usage, RegressionLinear
and RegressionPartitionedLinear
model objects do not store the training data or optimization details (for example, convergence history).
FitInfo
— Optimization details
structure array
Optimization details, returned as a structure array.
Fields specify final values or namevalue pair argument specifications,
for example, Objective
is the value of the objective
function when optimization terminates. Rows of multidimensional fields
correspond to values of Lambda
and columns correspond
to values of Solver
.
This table describes some notable fields.
Field  Description  

TerminationStatus 
 
FitTime  Elapsed, wallclock time in seconds  
History  A structure array of optimization information for each
iteration. The field

To access fields, use dot notation.
For example, to access the vector of objective function values for
each iteration, enter FitInfo.History.Objective
.
It is good practice to examine FitInfo
to
assess whether convergence is satisfactory.
HyperparameterOptimizationResults
— Crossvalidation optimization of hyperparameters
BayesianOptimization
object  table of hyperparameters and associated values
Crossvalidation 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'
namevalue 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 (crossvalidation loss), and rank of observations from lowest (best) to highest (worst) 
Note
If Learner
is 'leastsquares'
, then the loss term in the objective function is half of the MSE. loss
returns the MSE by default. Therefore, if you use loss
to check the resubstitution, or training, error then there is a discrepancy between the MSE returned by loss
and optimization results in FitInfo
or returned to the command line by setting a positive verbosity level using Verbose
.
More About
Warm Start
A warm start is initial estimates of the beta coefficients and bias term supplied to an optimization routine for quicker convergence.
Alternatives for LowerDimensional Data
fitclinear
and fitrlinear
minimize
objective functions relatively quickly for a highdimensional linear model at the cost of
some accuracy and with the restriction that the model must be linear with respect to the
parameters. If your predictor data set is low to mediumdimensional, you can use an
alternative classification or regression fitting function. To help you decide which fitting
function is appropriate for your data set, use this table.
Model to Fit  Function  Notable Algorithmic Differences 

SVM 
 
Linear regression 
 
Logistic regression 

Tips
It is a best practice to orient your predictor matrix so that observations correspond to columns and to specify
'ObservationsIn','columns'
. As a result, you can experience a significant reduction in optimizationexecution time.If your predictor data has few observations but many predictor variables, then:
Specify
'PostFitBias',true
.For SGD or ASGD solvers, set
PassLimit
to a positive integer that is greater than 1, for example, 5 or 10. This setting often results in better accuracy.
For SGD and ASGD solvers,
BatchSize
affects the rate of convergence.If
BatchSize
is too small, thenfitrlinear
achieves the minimum in many iterations, but computes the gradient per iteration quickly.If
BatchSize
is too large, thenfitrlinear
achieves the minimum in fewer iterations, but computes the gradient per iteration slowly.
Large learning rates (see
LearnRate
) speed up convergence to the minimum, but can lead to divergence (that is, overstepping the minimum). Small learning rates ensure convergence to the minimum, but can lead to slow termination.When using lasso penalties, experiment with various values of
TruncationPeriod
. For example, setTruncationPeriod
to1
,10
, and then100
.For efficiency,
fitrlinear
does not standardize predictor data. To standardizeX
where you orient the observations as the columns, enterX = normalize(X,2);
If you orient the observations as the rows, enter
X = normalize(X);
For memoryusage economy, the code replaces the original predictor data the standardized data.
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
If you specify
ValidationData
, then, during objectivefunction optimization:fitrlinear
estimates the validation loss ofValidationData
periodically using the current model, and tracks the minimal estimate.When
fitrlinear
estimates a validation loss, it compares the estimate to the minimal estimate.When subsequent, validation loss estimates exceed the minimal estimate five times,
fitrlinear
terminates optimization.
If you specify
ValidationData
and to implement a crossvalidation routine (CrossVal
,CVPartition
,Holdout
, orKFold
), then:fitrlinear
randomly partitionsX
andY
(orTbl
) according to the crossvalidation routine that you choose.fitrlinear
trains the model using the trainingdata partition. During objectivefunction optimization,fitrlinear
usesValidationData
as another possible way to terminate optimization (for details, see the previous bullet).Once
fitrlinear
satisfies a stopping criterion, it constructs a trained model based on the optimized linear coefficients and intercept.If you implement kfold crossvalidation, and
fitrlinear
has not exhausted all trainingset folds, thenfitrlinear
returns to Step 2 to train using the next trainingset fold.Otherwise,
fitrlinear
terminates training, and then returns the crossvalidated model.
You can determine the quality of the crossvalidated model. For example:
To determine the validation loss using the holdout or outoffold data from step 1, pass the crossvalidated model to
kfoldLoss
.To predict observations on the holdout or outoffold data from step 1, pass the crossvalidated model to
kfoldPredict
.
References
[1] Ho, C. H. and C. J. Lin. “LargeScale Linear Support Vector Regression.” Journal of Machine Learning Research, Vol. 13, 2012, pp. 3323–3348.
[2] Hsieh, C. J., K. W. Chang, C. J. Lin, S. S. Keerthi, and S. Sundararajan. “A Dual Coordinate Descent Method for LargeScale Linear SVM.” Proceedings of the 25th International Conference on Machine Learning, ICML ’08, 2001, pp. 408–415.
[3] Langford, J., L. Li, and T. Zhang. “Sparse Online Learning Via Truncated Gradient.” J. Mach. Learn. Res., Vol. 10, 2009, pp. 777–801.
[4] Nocedal, J. and S. J. Wright. Numerical Optimization, 2nd ed., New York: Springer, 2006.
[5] ShalevShwartz, S., Y. Singer, and N. Srebro. “Pegasos: Primal Estimated SubGradient Solver for SVM.” Proceedings of the 24th International Conference on Machine Learning, ICML ’07, 2007, pp. 807–814.
[6] Wright, S. J., R. D. Nowak, and M. A. T. Figueiredo. “Sparse Reconstruction by Separable Approximation.” Trans. Sig. Proc., Vol. 57, No 7, 2009, pp. 2479–2493.
[7] Xiao, Lin. “Dual Averaging Methods for Regularized Stochastic Learning and Online Optimization.” J. Mach. Learn. Res., Vol. 11, 2010, pp. 2543–2596.
[8] Xu, Wei. “Towards Optimal One Pass Large Scale Learning with Averaged Stochastic Gradient Descent.” CoRR, abs/1107.2490, 2011.
Extended Capabilities
Tall Arrays
Calculate with arrays that have more rows than fit in memory.
Usage notes and limitations:
fitrlinear
does not support talltable
data.Some namevalue pair arguments have different defaults and values compared to the inmemory
fitrlinear
function. Supported namevalue pair arguments, and any differences, are:'Epsilon'
'ObservationsIn'
— Supports only'rows'
.'Lambda'
— Can be'auto'
(default) or a scalar.'Learner'
'Regularization'
— Supports only'ridge'
.'Solver'
— Supports only'lbfgs'
.'Verbose'
— Default value is1
'Beta'
'Bias'
'FitBias'
— Supports onlytrue
.'Weights'
— Value must be a tall array.'HessianHistorySize'
'BetaTolerance'
— Default value is relaxed to1e3
.'GradientTolerance'
— Default value is relaxed to1e3
.'IterationLimit'
— Default value is relaxed to20
.'OptimizeHyperparameters'
— Value of'Regularization'
parameter must be'ridge'
.'HyperparameterOptimizationOptions'
— For crossvalidation, 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.
For tall arrays
fitrlinear
implements LBFGS by distributing the calculation of the loss and the gradient among different parts of the tall array at each iteration. Other solvers are not available for tall arrays.When initial values for
Beta
andBias
are not given,fitrlinear
first refines the initial estimates of the parameters by fitting the model locally to parts of the data and combining the coefficients by averaging.
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)
namevalue argument in the call to the fitrlinear
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 R2016aR2022a: Regularization method determines the solver used during hyperparameter optimization
Starting in R2022a, when you specify to optimize hyperparameters and do not
specify a Solver
value, fitrlinear
uses
either a Limitedmemory BFGS (LBFGS) solver or a Sparse Reconstruction by Separable
Approximation (SpaRSA) solver, depending on the regularization type selected during
each iteration of the hyperparameter optimization.
When
Regularization
is'ridge'
, the function sets theSolver
value to'lbfgs'
by default.When
Regularization
is'lasso'
, the function sets theSolver
value to'sparsa'
by default.
In previous releases, the default solver selection during hyperparameter
optimization depended on various factors, including the regularization type, learner
type, and number of predictors. For more information, see Solver
.
See Also
fitrsvm
 fitlm
 lasso
 ridge
 fitclinear
 predict
 kfoldPredict
 kfoldLoss
 RegressionLinear
 RegressionPartitionedLinear
Open Example
You have a modified version of this example. Do you want to open this example with your edits?
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)