Stationary#
- class tinygp.kernels.stationary.Stationary(scale: tinygp.helpers.JAXArray = <factory>, distance: tinygp.kernels.distance.Distance = L1Distance())[source]#
Bases:
Kernel
A stationary kernel is defined with respect to a distance metric
Note that a stationary kernel is always isotropic. If you need more non-isotropic length scales, wrap your kernel in a transform using
tinygp.transforms.Linear
ortinygp.transforms.Cholesky
.- Parameters:
scale – The length scale, in the same units as
distance
for the kernel. This must be a scalar.distance – An object that implements
distance
andsquared_distance
methods. Typically a subclass oftinygp.kernels.stationary.Distance
. Each stationary kernel also has adefault_distance
property that is used whendistance
isn’t provided.
- abstract evaluate(X1: tinygp.helpers.JAXArray, X2: tinygp.helpers.JAXArray) tinygp.helpers.JAXArray #
Evaluate the kernel at a pair of input coordinates
This should be overridden be subclasses to return the kernel-specific value. Two things to note:
Users shouldn’t generally call
Kernel.evaluate()
. Instead, always “call” the kernel instance directly; for example, you can evaluate the Matern-3/2 kernel usingMatern32(1.5)(x1, x2)
, for arrays of input coordinatesx1
andx2
.When implementing a custom kernel, this method should treat
X1
andX2
as single datapoints. In other words, these inputs will typically either be scalars of have shapen_dim
, wheren_dim
is the number of input dimensions, rather thann_data
or(n_data, n_dim)
, and you should let theKernel
vmap
magic handle all the broadcasting for you.
- evaluate_diag(X: tinygp.helpers.JAXArray) tinygp.helpers.JAXArray #
Evaluate the kernel on its diagonal
The default implementation simply calls
Kernel.evaluate()
withX
as both arguments, but subclasses can use this to make diagonal calcuations more efficient.