Skip to content

Latest commit

 

History

History
252 lines (148 loc) · 7.69 KB

PairwiseKernel.md

File metadata and controls

252 lines (148 loc) · 7.69 KB
Raw

PairwiseKernel

Wrapper for kernels in sklearn.metrics.pairwise.

A thin wrapper around the functionality of the kernels in sklearn.metrics.pairwise.

Python Reference

Constructors

constructor()

Signature

new PairwiseKernel(opts?: object): PairwiseKernel;

Parameters

Name Type Description
opts? object -
opts.gamma? number Parameter gamma of the pairwise kernel specified by metric. It should be positive. Default Value 1
opts.gamma_bounds? "fixed" The lower and upper bound on ‘gamma’. If set to “fixed”, ‘gamma’ cannot be changed during hyperparameter tuning.
opts.metric? "sigmoid" | "linear" | "poly" | "rbf" | "cosine" | "additive_chi2" | "chi2" | "polynomial" | "laplacian" The metric to use when calculating kernel between instances in a feature array. If metric is a string, it must be one of the metrics in pairwise.PAIRWISE_KERNEL_FUNCTIONS. If metric is “precomputed”, X is assumed to be a kernel matrix. Alternatively, if metric is a callable function, it is called on each pair of instances (rows) and the resulting value recorded. The callable should take two arrays from X as input and return a value indicating the distance between them. Default Value 'linear'
opts.pairwise_kernels_kwargs? any All entries of this dict (if any) are passed as keyword arguments to the pairwise kernel function.

Returns

PairwiseKernel

Defined in: generated/gaussian_process/kernels/PairwiseKernel.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/PairwiseKernel.ts:135

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/PairwiseKernel.ts:184

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/PairwiseKernel.ts:222

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/PairwiseKernel.ts:118

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/PairwiseKernel.ts:74

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/PairwiseKernel.ts:255

Properties

_isDisposed

boolean = false

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

_isInitialized

boolean = false

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

_py

PythonBridge

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

id

string

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

opts

any

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

Accessors

hyperparameter_gamma

Signature

hyperparameter_gamma(): Promise<any>;

Returns

Promise<any>

Defined in: generated/gaussian_process/kernels/PairwiseKernel.ts:278

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/gaussian_process/kernels/PairwiseKernel.ts:61

Signature

py(pythonBridge: PythonBridge): void;

Parameters

Name Type
pythonBridge PythonBridge

Returns

void

Defined in: generated/gaussian_process/kernels/PairwiseKernel.ts:65