Skip to content

Latest commit

 

History

History
264 lines (154 loc) · 7.25 KB

RBF.md

File metadata and controls

264 lines (154 loc) · 7.25 KB
Raw

RBF

Radial basis function kernel (aka squared-exponential kernel).

The RBF kernel is a stationary kernel. It is also known as the “squared exponential” kernel. It is parameterized by a length scale parameter \(l>0\), which can either be a scalar (isotropic variant of the kernel) or a vector with the same number of dimensions as the inputs X (anisotropic variant of the kernel). The kernel is given by:

Python Reference

Constructors

constructor()

Signature

new RBF(opts?: object): RBF;

Parameters

Name Type Description
opts? object -
opts.length_scale? number | ArrayLike 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. Default Value 1
opts.length_scale_bounds? "fixed" The lower and upper bound on ‘length_scale’. If set to “fixed”, ‘length_scale’ cannot be changed during hyperparameter tuning.

Returns

RBF

Defined in: generated/gaussian_process/kernels/RBF.ts:23

Methods

__call__()

Return the kernel k(X, Y) and optionally its gradient.

Signature

__call__(opts: object): Promise<ArrayLike[]>;

Parameters

Name Type Description
opts object -
opts.X? ArrayLike[] Left argument of the returned kernel k(X, Y)
opts.Y? ArrayLike[] Right argument of the returned kernel k(X, Y). If undefined, k(X, X) if evaluated instead.
opts.eval_gradient? boolean Determines whether the gradient with respect to the log of the kernel hyperparameter is computed. Only supported when Y is undefined. Default Value false

Returns

Promise<ArrayLike[]>

Defined in: generated/gaussian_process/kernels/RBF.ts:113

clone_with_theta()

Returns a clone of self with given hyperparameters theta.

Signature

clone_with_theta(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.theta? ArrayLike The hyperparameters

Returns

Promise<any>

Defined in: generated/gaussian_process/kernels/RBF.ts:162

diag()

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.

Signature

diag(opts: object): Promise<ArrayLike>;

Parameters

Name Type Description
opts object -
opts.X? ArrayLike[] Left argument of the returned kernel k(X, Y)

Returns

Promise<ArrayLike>

Defined in: generated/gaussian_process/kernels/RBF.ts:197

dispose()

Disposes of the underlying Python resources.

Once dispose() is called, the instance is no longer usable.

Signature

dispose(): Promise<void>;

Returns

Promise<void>

Defined in: generated/gaussian_process/kernels/RBF.ts:96

init()

Initializes the underlying Python resources.

This instance is not usable until the Promise returned by init() resolves.

Signature

init(py: PythonBridge): Promise<void>;

Parameters

Name Type
py PythonBridge

Returns

Promise<void>

Defined in: generated/gaussian_process/kernels/RBF.ts:53

is_stationary()

Returns whether the kernel is stationary.

Signature

is_stationary(opts: object): Promise<any>;

Parameters

Name Type
opts object

Returns

Promise<any>

Defined in: generated/gaussian_process/kernels/RBF.ts:229

Properties

_isDisposed

boolean = false

Defined in: generated/gaussian_process/kernels/RBF.ts:21

_isInitialized

boolean = false

Defined in: generated/gaussian_process/kernels/RBF.ts:20

_py

PythonBridge

Defined in: generated/gaussian_process/kernels/RBF.ts:19

id

string

Defined in: generated/gaussian_process/kernels/RBF.ts:16

opts

any

Defined in: generated/gaussian_process/kernels/RBF.ts:17

Accessors

anisotropic

Signature

anisotropic(): Promise<any>;

Returns

Promise<any>

Defined in: generated/gaussian_process/kernels/RBF.ts:252

hyperparameter_length_scale

Signature

hyperparameter_length_scale(): Promise<any>;

Returns

Promise<any>

Defined in: generated/gaussian_process/kernels/RBF.ts:272

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/gaussian_process/kernels/RBF.ts:40

Signature

py(pythonBridge: PythonBridge): void;

Parameters

Name Type
pythonBridge PythonBridge

Returns

void

Defined in: generated/gaussian_process/kernels/RBF.ts:44