Kernel

class baybe.kernels.base.Kernel[source]

Bases: ABC, SerialMixin

Abstract base class for all kernels.

Public methods

__init__()

Method generated by attrs for class Kernel.

from_dict(dictionary)

Create an object from its dictionary representation.

from_json(source, /)

Create an object from its JSON representation.

to_dict()

Create an object's dictionary representation.

to_factory()

Wrap the kernel in a baybe.surrogates.gaussian_process.kernel_factory.PlainKernelFactory.

to_gpytorch(*[, ard_num_dims, batch_shape, ...])

Create the gpytorch representation of the kernel.

to_json([sink, overwrite])

Create an object's JSON representation.
__init__()

Method generated by attrs for class Kernel.

For details on the parameters, see Public attributes and properties.

classmethod from_dict(dictionary: dict)

Create an object from its dictionary representation.

Parameters:

dictionary (dict) – The dictionary representation.

Return type:

TypeVar(_T, bound= SerialMixin)

Returns:

The reconstructed object.

classmethod from_json(source: str | Path | SupportsRead[str], /)

Create an object from its JSON representation.

Parameters:

source (str | Path | SupportsRead[str]) –

The JSON source. Can be:

  • A string containing JSON content.

  • A file path or Path object pointing to a JSON file.

  • A file-like object with a read() method.

Raises:

ValueError – If source is not one of the allowed types.

Return type:

_T

Returns:

The reconstructed object.

to_dict()

Create an object’s dictionary representation.

Return type:

dict

Returns:

The dictionary representation of the object.

to_factory()[source]

Wrap the kernel in a baybe.surrogates.gaussian_process.kernel_factory.PlainKernelFactory.

Return type:

PlainKernelFactory

to_gpytorch(*, ard_num_dims: int | None = None, batch_shape: Size | None = None, active_dims: tuple[int, ...] | None = None)[source]

Create the gpytorch representation of the kernel.

to_json(sink: str | Path | SupportsWrite[str] | None = None, /, *, overwrite: bool = False, **kwargs: Any)

Create an object’s JSON representation.

Parameters:

  • sink (str | Path | SupportsWrite[str] | None) –

    The JSON sink. Can be:

    • None (only returns the JSON string).

    • A file path or Path object pointing to a location where to write the JSON content.

    • A file-like object with a write() method.

  • overwrite (bool) – Boolean flag indicating if to overwrite the file if it already exists. Only relevant if sink is a file path or Path object.

  • **kwargs (Any) – Additional keyword arguments to pass to json.dumps().

Raises:

FileExistsError – If sink points to an already existing file but overwrite is False.

Return type:

str

Returns:

The JSON representation as a string.