Documentation
Classes
WhiteKernel

WhiteKernel

White kernel.

The main use-case of this kernel is as part of a sum-kernel where it explains the noise of the signal as independently and identically normally-distributed. The parameter noise_level equals the variance of this noise.

Python Reference (opens in a new tab)

Constructors

constructor()

Signature

new WhiteKernel(opts?: object): WhiteKernel;

Parameters

NameTypeDescription
opts?object-
opts.noise_level?numberParameter controlling the noise level (variance) Default Value 1
opts.noise_level_bounds?"fixed"The lower and upper bound on ‘noise_level’. If set to “fixed”, ‘noise_level’ cannot be changed during hyperparameter tuning.

Returns

WhiteKernel

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:23 (opens in a new tab)

Properties

_isDisposed

boolean = false

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:21 (opens in a new tab)

_isInitialized

boolean = false

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:20 (opens in a new tab)

_py

PythonBridge

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:19 (opens in a new tab)

id

string

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:16 (opens in a new tab)

opts

any

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:17 (opens in a new tab)

Accessors

hyperparameter_noise_level

Signature

hyperparameter_noise_level(): Promise<any>;

Returns

Promise<any>

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:250 (opens in a new tab)

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:40 (opens in a new tab)

Signature

py(pythonBridge: PythonBridge): void;

Parameters

NameType
pythonBridgePythonBridge

Returns

void

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:44 (opens in a new tab)

Methods

__call__()

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

Signature

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

Parameters

NameTypeDescription
optsobject-
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) is evaluated instead.
opts.eval_gradient?booleanDetermines 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/WhiteKernel.ts:110 (opens in a new tab)

clone_with_theta()

Returns a clone of self with given hyperparameters theta.

Signature

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

Parameters

NameTypeDescription
optsobject-
opts.theta?ArrayLikeThe hyperparameters

Returns

Promise<any>

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:159 (opens in a new tab)

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

NameTypeDescription
optsobject-
opts.X?ArrayLike[]Argument to the kernel.

Returns

Promise<ArrayLike>

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:194 (opens in a new tab)

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/WhiteKernel.ts:93 (opens in a new tab)

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

NameType
pyPythonBridge

Returns

Promise<void>

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:53 (opens in a new tab)

is_stationary()

Returns whether the kernel is stationary.

Signature

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

Parameters

NameType
optsobject

Returns

Promise<any>

Defined in: generated/gaussian_process/kernels/WhiteKernel.ts:227 (opens in a new tab)