**Superclasses: **`CompactRegressionGP`

Gaussian process regression model class

`RegressionGP`

is a Gaussian process regression
(GPR) model. You can train a GPR model, using `fitrgp`

.
Using the trained model, you can

Predict responses for training data using

`resubPredict`

or new predictor data using`predict`

. You can also compute the prediction intervals.Compute the regression loss for training data using

`resubLoss`

or new data using`loss`

.

Create a `RegressionGP`

object by using `fitrgp`

.

`FitMethod`

— Method used to estimate the parameters`'none'`

| `'exact'`

| `'sd'`

| `'sr'`

| `'fic'`

Method used to estimate the basis function coefficients, β; noise standard deviation, σ; and kernel parameters, θ, of the GPR model, stored as a character vector. It can be one of the following.

Fit Method | Description |
---|---|

`'none'` | No estimation. `fitrgp` uses
the initial parameter values as the parameter values. |

`'exact'` | Exact Gaussian process regression. |

`'sd'` | Subset of data points approximation. |

`'sr'` | Subset of regressors approximation. |

`'fic'` | Fully independent conditional approximation. |

`BasisFunction`

— Explicit basis function`'none'`

| `'constant'`

| `'linear'`

| `'pureQuadratic'`

| function handleExplicit basis function used in the GPR model, stored as a character
vector or a function handle. It can be one of the following. If *n* is
the number of observations, the basis function adds the term ** H***

Explicit Basis | Basis Matrix |
---|---|

`'none'` | Empty matrix. |

`'constant'` |
$$H=1$$ ( |

`'linear'` |
$$H=[1,X]$$ |

`'pureQuadratic'` |
$$H=\left[1,X,{X}_{2}\right],$$ where $${X}_{2}=\left[\begin{array}{cccc}{x}_{11}^{2}& {x}_{12}^{2}& \cdots & {x}_{1d}^{2}\\ {x}_{21}^{2}& {x}_{22}^{2}& \cdots & {x}_{2d}^{2}\\ \vdots & \vdots & \vdots & \vdots \\ {x}_{n1}^{2}& {x}_{n2}^{2}& \cdots & {x}_{nd}^{2}\end{array}\right].$$ |

Function handle | Function handle, $$H=hfcn(X),$$ where |

**Data Types: **`char`

| `function_handle`

`Beta`

— Estimated coefficientsvector

Estimated coefficients for the explicit basis functions, stored
as a vector. You can define the explicit basis function by using the `BasisFunction`

name-value
pair argument in `fitrgp`

.

**Data Types: **`double`

`Sigma`

— Estimated noise standard deviationscalar value

Estimated noise standard deviation of the GPR model, stored as a scalar value.

**Data Types: **`double`

`CategoricalPredictors`

— Indices of categorical predictorsvector of positive integers

Categorical predictor
indices, specified as a vector of positive integers. `CategoricalPredictors`

contains index values corresponding to the columns of the predictor data that contain
categorical predictors. If none of the predictors are categorical, then this property is empty
(`[]`

).

**Data Types: **`single`

| `double`

`HyperparameterOptimizationResults`

— Description of cross-validation optimization of hyperparameters`BayesianOptimization`

object | tableDescription of the cross-validation optimization of hyperparameters, specified as a
`BayesianOptimization`

object or a table of
hyperparameters and associated values. This property is nonempty if the
`'OptimizeHyperparameters'`

name-value pair argument is nonempty
when you create the model. The value of
`HyperparameterOptimizationResults`

depends on the setting of the
`Optimizer`

field in the
`HyperparameterOptimizationOptions`

structure when you create the
model, as described in this table.

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) |

`LogLikelihood`

— Maximized marginal log likelihoodscalar value |

`[]`

Maximized marginal log likelihood of the GPR model, stored as
a scalar value if the `FitMethod`

is different
from `'none'`

. If `FitMethod`

is `'none'`

,
then `LogLikelihood`

is empty.

If `FitMethod`

is `'sd'`

, `'sr'`

,
or `'fic'`

, then `LogLikelihood`

is
the maximized approximation of the marginal log likelihood of the
GPR model.

**Data Types: **`double`

`ModelParameters`

— Parameters used for training `GPParams`

objectParameters used for training the GPR model, stored as a `GPParams`

object.

`KernelFunction`

— Form of the covariance function`'squaredExponential'`

| `'matern32'`

| `'matern52'`

| `'ardsquaredexponential'`

| `'ardmatern32'`

| `'ardmatern52'`

| function handleForm of the covariance function used in the GPR model, stored as a character vector containing the name of the built-in covariance function or a function handle. It can be one of the following.

Function | Description |
---|---|

`'squaredexponential'` | Squared exponential kernel. |

`'matern32'` | Matern kernel with parameter 3/2. |

`'matern52'` | Matern kernel with parameter 5/2. |

`'ardsquaredexponential'` | Squared exponential kernel with a separate length scale per predictor. |

`'ardmatern32'` | Matern kernel with parameter 3/2 and a separate length scale per predictor. |

`'ardmatern52'` | Matern kernel with parameter 5/2 and a separate length scale per predictor. |

Function handle | A function handle that `fitrgp` can call
like this:`Kmn = kfcn(Xm,Xn,theta)` where `Xm` is an m-by-d matrix, `Xn` is
an n-by-d matrix and `Kmn` is
an m-by-n matrix of kernel products
such that `Kmn` (i,j)
is the kernel product between `Xm` (i,:)
and `Xn` (j,:). `theta` is
the r-by-1 unconstrained parameter vector for `kfcn` . |

**Data Types: **`char`

| `function_handle`

`KernelInformation`

— Information about the parameters of the kernel functionstructure

Information about the parameters of the kernel function used in the GPR model, stored as a structure with the following fields.

Field Name | Description |
---|---|

`Name` | Name of the kernel function |

`KernelParameters` | Vector of the estimated kernel parameters |

`KernelParameterNames` | Names associated with the elements of `KernelParameters` . |

**Data Types: **`struct`

`PredictMethod`

— Method used to make predictions`'exact'`

| `'bcd'`

| `'sd'`

| `'sr'`

| `'fic'`

Method that `predict`

uses to make predictions
from the GPR model, stored as a character vector. It can be one of
the following.

PredictMethod | Description |
---|---|

`'exact'` | Exact Gaussian process regression |

`'bcd'` | Block Coordinate Descent |

`'sd'` | Subset of Data points approximation |

`'sr'` | Subset of Regressors approximation |

`'fic'` | Fully Independent Conditional approximation |

`Alpha`

— Weights numeric vector

Weights used to make predictions from the trained GPR model,
stored as a numeric vector. `predict`

computes the
predictions for a new predictor matrix `Xnew`

by
using the product

$$K\left({X}_{new},A\right)*\alpha \text{\hspace{0.17em}}.$$

$$K\left({X}_{new},A\right)$$ is
the matrix of kernel products between $${X}_{new}$$ and
active set vector ** A** and

**Data Types: **`double`

`BCDInformation`

— Information on BCD-based computation of `Alpha`

structure |

`[]`

Information on block coordinate descent (BCD)-based computation
of `Alpha`

when `PredictMethod`

is `'bcd'`

,
stored as a structure containing the following fields.

Field Name | Description |
---|---|

`Gradient` | n-by-1 vector containing the gradient of
the BCD objective function at convergence. |

`Objective` | Scalar containing the BCD objective function at convergence. |

`SelectionCounts` | n-by-1 integer vector indicating the number
of times each point was selected into a block during BCD. |

`Alpha`

property contains the `Alpha`

vector
computed from BCD.

If `PredictMethod`

is not `'bcd'`

,
then `BCDInformation`

is empty.

**Data Types: **`struct`

`ResponseTransform`

— Transformation applied to predicted response`'none'`

(default)Transformation applied to the predicted response, stored as a character vector describing how
the response values predicted by the model are transformed. In `RegressionGP`

, `ResponseTransform`

is
`'none'`

by default, and `RegressionGP`

does not use `ResponseTransform`

when
making predictions.

`ActiveSetVectors`

— Subset of training datamatrix

Subset of training data used to make predictions from the GPR model, stored as a matrix.

`predict`

computes the predictions for a new
predictor matrix `Xnew`

by using the product

$$K\left({X}_{new},A\right)*\alpha \text{\hspace{0.17em}}.$$

$$K\left({X}_{new},A\right)$$ is
the matrix of kernel products between $${X}_{new}$$ and
active set vector ** A** and

`ActiveSetVectors`

is equal to the training
data `X`

for exact GPR fitting and a subset of
the training data `X`

for sparse GPR methods. When
there are categorical predictors in the model, `ActiveSetVectors`

contains
dummy variables for the corresponding predictors.

**Data Types: **`double`

`ActiveSetHistory`

— History of active set selection and parameter estimationstructure

History of interleaved active
set selection and parameter estimation for `FitMethod`

equal
to `'sd'`

, `'sr'`

, or `'fic'`

,
stored as a structure with the following fields.

Field Name | Description |
---|---|

`ParameterVector` | Cell array containing the parameter vectors: basis function
coefficients, β, kernel function parameters θ,
and noise standard deviation σ. |

`ActiveSetIndices` | Cell array containing the active set indices. |

`Loglikelihood` | Vector containing the maximized log likelihoods. |

`CriterionProfile` | Cell array containing the active set selection criterion values as the active set grows from size 0 to its final size. |

**Data Types: **`struct`

`ActiveSetMethod`

— Method used to select the active set`'sgma'`

| `'entropy'`

| `'likelihood'`

| `'random'`

Method used to select the active set for sparse methods (`'sd'`

,`'sr'`

,
or `'fic'`

), stored as a character vector. It can
be one of the following.

ActiveSetMethod | Description |
---|---|

`'sgma'` | Sparse greedy matrix approximation |

`'entropy'` | Differential entropy-based selection |

`'likelihood'` | Subset of regressors log likelihood-based selection |

`'random'` | Random selection |

The selected active set is
used in parameter estimation or prediction, depending on the choice
of `FitMethod`

and `PredictMethod`

in `fitrgp`

.

`ActiveSetSize`

— Size of the active setinteger value

Size of the active set for sparse methods (`'sd'`

,`'sr'`

,
or `'fic'`

), stored as an integer value.

**Data Types: **`double`

`IsActiveSetVector`

— Indicators for selected active setlogical vector

Indicators for selected active set for making predictions from
the trained GPR model, stored as a logical vector. These indicators
mark the subset of training data that `fitrgp`

selects
as the active set. For example, if `X`

is the original
training data, then `ActiveSetVectors = X(IsActiveSetVector,:)`

.

**Data Types: **`logical`

`NumObservations`

— Number of observations in training datascalar value

Number of observations in training data, stored as a scalar value.

**Data Types: **`double`

`X`

— Training dataTraining data, stored as an *n*-by-*d* table
or matrix, where *n* is the number of observations
and *d* is the number of predictor variables (columns)
in the training data. If the GPR model is trained on a table, then `X`

is
a table. Otherwise, `X`

is a matrix.

**Data Types: **`double`

| `table`

`Y`

— Observed response valuesObserved response values used to train the GPR model, stored
as an *n*-by-1 vector, where *n* is
the number of observations.

**Data Types: **`double`

`PredictorNames`

— Names of predictorscell array of character vectors

Names of predictors used in the GPR model, stored as a cell
array of character vectors. Each name (cell) corresponds to a column
in `X`

.

**Data Types: **`cell`

`ExpandedPredictorNames`

— Names of expanded predictorscell array of character vectors

Names of expanded predictors for the GPR model, stored as a
cell array of character vectors. Each name (cell) corresponds to a
column in `ActiveSetVectors`

.

If the model uses dummy variables for categorical variables,
then `ExpandedPredictorNames`

includes the names
that describe the expanded variables. Otherwise, `ExpandedPredictorNames`

is
the same as `PredictorNames`

.

**Data Types: **`cell`

`ResponseName`

— Name of the response variablecharacter vector

Name of the response variable in the GPR model, stored as a character vector.

**Data Types: **`char`

`PredictorLocation`

— Means of predictors1-by-

`[]`

Means of predictors used for training the GPR model if the training
data is standardized, stored as a 1-by-*d* vector.
If the training data is not standardized, `PredictorLocation`

is
empty.

If `PredictorLocation`

is not empty, then
the `predict`

method
centers the predictor values by subtracting the respective element
of `PredictorLocation`

from every column of `X`

.

If there are categorical predictors, then `PredictorLocation`

includes
a 0 for each dummy variable corresponding to those predictors. The
dummy variables are not centered or scaled.

**Data Types: **`double`

`PredictorScale`

— Standard deviations of predictors1-by-

`[]`

Standard deviations of predictors used for training the GPR
model if the training data is standardized, stored as a 1-by-*d* vector.
If the training data is not standardized, `PredictorScale`

is
empty.

If `PredictorScale`

is not empty, the `predict`

method
scales the predictors by dividing every column of `X`

by
the respective element of `PredictorScale`

(after
centering using `PredictorLocation`

).

If there are categorical predictors, then `PredictorLocation`

includes
a 1 for each dummy variable corresponding to those predictors. The
dummy variables are not centered or scaled.

**Data Types: **`double`

`RowsUsed`

— Indicators for rows used in traininglogical vector |

`[]`

Indicators for rows used in training the GPR model, stored as
a logical vector. If all rows are used in training the model, then `RowsUsed`

is
empty.

**Data Types: **`logical`

compact | Create compact Gaussian process regression model |

crossval | Cross-validate Gaussian process regression model |

postFitStatistics | Compute post-fit statistics for the exact Gaussian process regression model |

resubLoss | Resubstitution loss for a trained Gaussian process regression model |

resubPredict | Resubstitution prediction from a trained Gaussian process regression model |

For subset of data, subset of regressors, or fully independent
conditional approximation fitting methods (`FitMethod`

equal to `'sd'`

, `'sr'`

,
or `'fic'`

), if you do not provide the active set, `fitrgp`

selects the active set and computes
the parameter estimates in a series of iterations.

In the first iteration, the software uses the initial parameter
values in vector *η*_{0} =
[*β*_{0},*σ*_{0},*θ*_{0}]
to select an active set A_{1}. It maximizes the
GPR marginal log likelihood or its approximation using η_{0} as
the initial values and A_{1} to compute the new
parameter estimates η_{1}. Next, it computes
the new log likelihood *L*_{1} using
η_{1} and A_{1}.

In the second iteration, the software selects the active set
A_{2} using the parameter values in η_{1}.
Then, using η_{1} as the initial values
and A_{2}, it maximizes the GPR marginal log likelihood
or its approximation and estimates the new parameter values η_{2}.
Then using η_{2} and A_{2},
computes the new log likelihood value *L*_{2}.

The following table summarizes the iterations and what is computed at each iteration.

Iteration Number | Active Set | Parameter Vector | Log Likelihood |
---|---|---|---|

1 | A_{1} | η_{1} | L_{1} |

2 | A_{2} | η_{2} | L_{2} |

3 | A_{3} | η_{3} | L_{3} |

… | … | … | … |

The software iterates similarly for a specified number of repetitions.
You can specify the number of replications for active set selection
using the `NumActiveSetRepeats`

name-value
pair argument.

You can access the properties of this class using dot notation. For example,

`KernelInformation`

is a structure holding the kernel parameters and their names. Hence, to access the kernel function parameters of the trained model`gprMdl`

, use`gprMdl.KernelInformation.KernelParameters`

.

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

Usage notes and limitations:

The

`predict`

function supports code generation.When you train a Gaussian process regression model by using

`fitrgp`

, you cannot supply training data in a table that contains a logical vector, character array, categorical array, string array, or cell array of character vectors. Also, you cannot use the`'CategoricalPredictors'`

name-value pair argument. Code generation does not support categorical predictors. To include categorical predictors in a model, preprocess the categorical predictors by using`dummyvar`

before fitting the model.

For more information, see Introduction to Code Generation.

`CompactRegressionGP`

| `compact`

| `fitrgp`

| `plotPartialDependence`

- Class Attributes (MATLAB)
- Property Attributes (MATLAB)

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.

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: .

Select web siteYou can also select a web site from the following list:

Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.

- América Latina (Español)
- Canada (English)
- United States (English)

- 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)