sklearn.gaussian_process.kernels.Matern¶
-
class
sklearn.gaussian_process.kernels.Matern(length_scale=1.0, length_scale_bounds=(1e-05, 100000.0), nu=1.5)[source]¶ Matern kernel.
The class of Matern kernels is a generalization of the RBF and the absolute exponential kernel parameterized by an additional parameter nu. The smaller nu, the less smooth the approximated function is. For nu=inf, the kernel becomes equivalent to the RBF kernel and for nu=0.5 to the absolute exponential kernel. Important intermediate values are nu=1.5 (once differentiable functions) and nu=2.5 (twice differentiable functions).
See Rasmussen and Williams 2006, pp84 for details regarding the different variants of the Matern kernel.
New in version 0.18.
- Parameters
- length_scalefloat or array with shape (n_features,), default: 1.0
The length scale of the kernel. If a float, an isotropic kernel is used. If an array, an anisotropic kernel is used where each dimension of l defines the length-scale of the respective feature dimension.
- length_scale_boundspair of floats >= 0, default: (1e-5, 1e5)
The lower and upper bound on length_scale
- nufloat, default: 1.5
The parameter nu controlling the smoothness of the learned function. The smaller nu, the less smooth the approximated function is. For nu=inf, the kernel becomes equivalent to the RBF kernel and for nu=0.5 to the absolute exponential kernel. Important intermediate values are nu=1.5 (once differentiable functions) and nu=2.5 (twice differentiable functions). Note that values of nu not in [0.5, 1.5, 2.5, inf] incur a considerably higher computational cost (appr. 10 times higher) since they require to evaluate the modified Bessel function. Furthermore, in contrast to l, nu is kept fixed to its initial value and not optimized.
- Attributes
- anisotropic
boundsReturns the log-transformed bounds on the theta.
- hyperparameter_length_scale
hyperparametersReturns a list of all hyperparameter specifications.
n_dimsReturns the number of non-fixed hyperparameters of the kernel.
requires_vector_inputReturns whether the kernel is defined on fixed-length feature vectors or generic objects.
thetaReturns the (flattened, log-transformed) non-fixed hyperparameters.
Methods
__call__(self, X[, Y, eval_gradient])Return the kernel k(X, Y) and optionally its gradient.
clone_with_theta(self, theta)Returns a clone of self with given hyperparameters theta.
diag(self, X)Returns the diagonal of the kernel k(X, X).
get_params(self[, deep])Get parameters of this kernel.
is_stationary(self)Returns whether the kernel is stationary.
set_params(self, \*\*params)Set the parameters of this kernel.
-
__init__(self, length_scale=1.0, length_scale_bounds=(1e-05, 100000.0), nu=1.5)[source]¶ Initialize self. See help(type(self)) for accurate signature.
-
__call__(self, X, Y=None, eval_gradient=False)[source]¶ Return the kernel k(X, Y) and optionally its gradient.
- Parameters
- Xarray, shape (n_samples_X, n_features)
Left argument of the returned kernel k(X, Y)
- Yarray, shape (n_samples_Y, n_features), (optional, default=None)
Right argument of the returned kernel k(X, Y). If None, k(X, X) if evaluated instead.
- eval_gradientbool (optional, default=False)
Determines whether the gradient with respect to the kernel hyperparameter is determined. Only supported when Y is None.
- Returns
- Karray, shape (n_samples_X, n_samples_Y)
Kernel k(X, Y)
- K_gradientarray (opt.), shape (n_samples_X, n_samples_X, n_dims)
The gradient of the kernel k(X, X) with respect to the hyperparameter of the kernel. Only returned when eval_gradient is True.
-
property
bounds¶ Returns the log-transformed bounds on the theta.
- Returns
- boundsarray, shape (n_dims, 2)
The log-transformed bounds on the kernel’s hyperparameters theta
-
clone_with_theta(self, theta)[source]¶ Returns a clone of self with given hyperparameters theta.
- Parameters
- thetaarray, shape (n_dims,)
The hyperparameters
-
diag(self, X)[source]¶ Returns the diagonal of the kernel k(X, X).
The result of this method is identical to np.diag(self(X)); however, it can be evaluated more efficiently since only the diagonal is evaluated.
- Parameters
- Xsequence of length n_samples
Left argument of the returned kernel k(X, Y)
- Returns
- K_diagarray, shape (n_samples_X,)
Diagonal of kernel k(X, X)
-
get_params(self, deep=True)[source]¶ Get parameters of this kernel.
- Parameters
- deepboolean, optional
If True, will return the parameters for this estimator and contained subobjects that are estimators.
- Returns
- paramsmapping of string to any
Parameter names mapped to their values.
-
property
hyperparameters¶ Returns a list of all hyperparameter specifications.
-
property
n_dims¶ Returns the number of non-fixed hyperparameters of the kernel.
-
property
requires_vector_input¶ Returns whether the kernel is defined on fixed-length feature vectors or generic objects. Defaults to True for backward compatibility.
-
set_params(self, **params)[source]¶ Set the parameters of this kernel.
The method works on simple kernels as well as on nested kernels. The latter have parameters of the form
<component>__<parameter>so that it’s possible to update each component of a nested object.- Returns
- self
-
property
theta¶ Returns the (flattened, log-transformed) non-fixed hyperparameters.
Note that theta are typically the log-transformed values of the kernel’s hyperparameters as this representation of the search space is more amenable for hyperparameter search, as hyperparameters like length-scales naturally live on a log-scale.
- Returns
- thetaarray, shape (n_dims,)
The non-fixed, log-transformed hyperparameters of the kernel
