Class: Product

The Product kernel takes two kernels \(k_1\) and \(k_2\) and combines them via

Python Reference

Constructors

new Product()

new Product(opts?): Product

Parameters

ParameterTypeDescription
opts?object-
opts.k1?anyThe first base-kernel of the product-kernel
opts.k2?anyThe second base-kernel of the product-kernel

Returns Product

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

Properties

PropertyTypeDefault valueDefined in
_isDisposedbooleanfalsegenerated/gaussian_process/kernels/Product.ts:19
_isInitializedbooleanfalsegenerated/gaussian_process/kernels/Product.ts:18
_pyPythonBridgeundefinedgenerated/gaussian_process/kernels/Product.ts:17
idstringundefinedgenerated/gaussian_process/kernels/Product.ts:14
optsanyundefinedgenerated/gaussian_process/kernels/Product.ts:15

Accessors

py

Get Signature

get py(): PythonBridge

Returns PythonBridge

Set Signature

set py(pythonBridge): void

Parameters

ParameterType
pythonBridgePythonBridge

Returns void

Defined in generated/gaussian_process/kernels/Product.ts:36

Methods

__call__()

__call__(opts): Promise<ArrayLike[]>

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

Parameters

ParameterTypeDescription
optsobject-
opts.eval_gradient?booleanDetermines whether the gradient with respect to the log of the kernel hyperparameter is computed.
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.

Returns Promise<ArrayLike[]>

Defined in generated/gaussian_process/kernels/Product.ts:104


clone_with_theta()

clone_with_theta(opts): Promise<any>

Returns a clone of self with given hyperparameters theta.

Parameters

ParameterTypeDescription
optsobject-
opts.theta?ArrayLikeThe hyperparameters

Returns Promise<any>

Defined in generated/gaussian_process/kernels/Product.ts:148


diag()

diag(opts): Promise<ArrayLike>

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

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

Returns Promise<ArrayLike>

Defined in generated/gaussian_process/kernels/Product.ts:182


dispose()

dispose(): Promise<void>

Disposes of the underlying Python resources.

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

Returns Promise<void>

Defined in generated/gaussian_process/kernels/Product.ts:87


init()

init(py): Promise<void>

Initializes the underlying Python resources.

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

Parameters

ParameterType
pyPythonBridge

Returns Promise<void>

Defined in generated/gaussian_process/kernels/Product.ts:49


is_stationary()

is_stationary(opts): Promise<any>

Returns whether the kernel is stationary.

Parameters

ParameterType
optsobject

Returns Promise<any>

Defined in generated/gaussian_process/kernels/Product.ts:214