Icm

ICMKernel

ICMKernel(
    base_kernel: AbstractKernel,
    coregionalization_matrix: CoregionalizationMatrix,
)

Bases: MultiOutputKernel

Intrinsic Coregionalization Model kernel.

Combines a single shared input kernel with a coregionalization matrix to produce a Kronecker-structured covariance: K = B (x) K_input.

Parameters:

• base_kernel (AbstractKernel) –

  The shared input-space kernel.

• coregionalization_matrix (CoregionalizationMatrix) –

  The output-space coregionalization.

cross_covariance

cross_covariance(
    x: Num[Array, "N D"], y: Num[Array, "M D"]
) -> Float[Array, ...]

Cross-covariance for multi-output kernels.

Returns shape [NP, MP] where P is num_outputs — overrides the single-output [N, M] annotation.

gram

gram(x: Num[Array, 'N D']) -> LinearOperator

Compute the gram matrix of the kernel.

Parameters:

• x (Num[Array, 'N D']) –

  the input matrix of shape (N, D).

Returns:

• LinearOperator –

  The gram matrix of the kernel of shape (N, N).

diagonal

diagonal(x: Num[Array, 'N D']) -> LinearOperator

Compute the diagonal of the gram matrix of the kernel.

Parameters:

• x (Num[Array, 'N D']) –

  the input matrix of shape (N, D).

Returns:

• LinearOperator –

  The diagonal of the gram matrix of the kernel of shape (N,).

slice_input

slice_input(
    x: Float[Array, "... D"],
) -> Float[Array, "... Q"]

Slice out the relevant columns of the input matrix.

Select the relevant columns of the supplied matrix to be used within the kernel's evaluation.

Parameters:

• x (Float[Array, '... D']) –

  the matrix or vector that is to be sliced.

Returns:

• Float[Array, '... Q'] –

  The sliced form of the input matrix.

__add__

__add__(
    other: Union[AbstractKernel, ScalarFloat],
) -> AbstractKernel

Add two kernels together. Args: other (AbstractKernel): The kernel to be added to the current kernel.

Returns:

• AbstractKernel ( AbstractKernel ) –

  A new kernel that is the sum of the two kernels.

__mul__

__mul__(
    other: Union[AbstractKernel, ScalarFloat],
) -> AbstractKernel

Multiply two kernels together.

Parameters:

• other (AbstractKernel) –

  The kernel to be multiplied with the current kernel.

Returns:

• AbstractKernel ( AbstractKernel ) –

  A new kernel that is the product of the two kernels.