Skip to content

Latest commit

 

History

History
235 lines (137 loc) · 6.29 KB

CompoundKernel.md

File metadata and controls

235 lines (137 loc) · 6.29 KB
Raw

CompoundKernel

Kernel which is composed of a set of other kernels.

Python Reference

Constructors

constructor()

Signature

new CompoundKernel(opts?: object): CompoundKernel;

Parameters

Name Type Description
opts? object -
opts.kernels? any The other kernels

Returns

CompoundKernel

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

Methods

__call__()

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

Note that this compound kernel returns the results of all simple kernel stacked along an additional axis.

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) is evaluated instead.
opts.eval_gradient? boolean Determines whether the gradient with respect to the log of the kernel hyperparameter is computed. Default Value false

Returns

Promise<ArrayLike[][]>

Defined in: generated/gaussian_process/kernels/CompoundKernel.ts:103

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/CompoundKernel.ts:152

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[] Argument to the kernel.

Returns

Promise<ArrayLike[]>

Defined in: generated/gaussian_process/kernels/CompoundKernel.ts:190

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/CompoundKernel.ts:84

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/CompoundKernel.ts:44

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/CompoundKernel.ts:223

Properties

_isDisposed

boolean = false

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

_isInitialized

boolean = false

Defined in: generated/gaussian_process/kernels/CompoundKernel.ts:18

_py

PythonBridge

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

id

string

Defined in: generated/gaussian_process/kernels/CompoundKernel.ts:14

opts

any

Defined in: generated/gaussian_process/kernels/CompoundKernel.ts:15

Accessors

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/gaussian_process/kernels/CompoundKernel.ts:31

Signature

py(pythonBridge: PythonBridge): void;

Parameters

Name Type
pythonBridge PythonBridge

Returns

void

Defined in: generated/gaussian_process/kernels/CompoundKernel.ts:35