keops periodic and keops kernels unit tests

.conda/meta.yaml

@@ -18,7 +18,7 @@ requirements:
   run:
     - pytorch>=1.11
     - scikit-learn
-    - linear_operator>=0.4.0
+    - linear_operator>=0.5.0
 
 test:
   imports:

.github/workflows/run_test_suite.yml

@@ -55,6 +55,7 @@ jobs:
         pip install -e .
         if [[ ${{ matrix.extras }} == "with-extras" ]]; then
           pip install "pyro-ppl>=1.8";
+          pip install pykeops;
           pip install faiss-cpu;  # Unofficial pip release: https://pypi.org/project/faiss-cpu/#history
         fi
     - name: Run unit tests
@@ -75,7 +76,8 @@ jobs:
         pip install pytest nbval jupyter tqdm matplotlib torchvision scipy
         pip install -e .
         pip install "pyro-ppl>=1.8";
-          pip install faiss-cpu;  # Unofficial pip release: https://pypi.org/project/faiss-cpu/#history
+        pip install pykeops;
+        pip install faiss-cpu;  # Unofficial pip release: https://pypi.org/project/faiss-cpu/#history
     - name: Run example notebooks
       run: |
         grep -l smoke_test examples/**/*.ipynb | xargs grep -L 'smoke_test = False' | CI=true xargs pytest --nbval-lax --current-env

docs/requirements.txt

@@ -1,7 +1,7 @@
 setuptools_scm<=7.1.0
 ipython<=8.6.0
 ipykernel<=6.17.1
-linear_operator>=0.4.0
+linear_operator>=0.5.0
 m2r2<=0.3.3.post2
 nbclient<=0.7.3
 nbformat<=5.8.0

docs/source/index.rst

@@ -29,6 +29,7 @@ GPyTorch's documentation
    models
    likelihoods
    kernels
+   keops_kernels
    means
    marginal_log_likelihoods
    metrics

docs/source/keops_kernels.rst

@@ -0,0 +1,41 @@
+.. role:: hidden
+    :class: hidden-section
+
+gpytorch.kernels.keops
+===================================
+
+.. automodule:: gpytorch.kernels.keops
+.. currentmodule:: gpytorch.kernels.keops
+
+
+These kernels are compatible with the GPyTorch KeOps integration.
+For more information, see the `KeOps tutorial`_.
+
+.. note::
+   Only some standard kernels have KeOps impementations.
+   If there is a kernel you want that's missing, consider submitting a pull request!
+
+
+.. _KeOps Tutorial:
+   examples/02_Scalable_Exact_GPs/KeOps_GP_Regression.html
+
+
+:hidden:`RBFKernel`
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: RBFKernel
+   :members:
+
+
+:hidden:`MaternKernel`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: MaternKernel
+   :members:
+
+
+:hidden:`PeriodicKernel`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: PeriodicKernel
+   :members:

gpytorch/kernels/keops/__init__.py

@@ -1,4 +1,5 @@
 from .matern_kernel import MaternKernel
+from .periodic_kernel import PeriodicKernel
 from .rbf_kernel import RBFKernel
 
-__all__ = ["MaternKernel", "RBFKernel"]
+__all__ = ["MaternKernel", "RBFKernel", "PeriodicKernel"]

gpytorch/kernels/keops/keops_kernel.py

@@ -1,18 +1,41 @@
 from abc import abstractmethod
+from typing import Any
 
 import torch
+from torch import Tensor
 
+from ... import settings
 from ..kernel import Kernel
 
 try:
-    from pykeops.torch import LazyTensor as KEOLazyTensor
+    import pykeops  # noqa F401
 
     class KeOpsKernel(Kernel):
         @abstractmethod
-        def covar_func(self, x1: torch.Tensor, x2: torch.Tensor) -> KEOLazyTensor:
-            raise NotImplementedError("KeOpsKernels must define a covar_func method")
+        def _nonkeops_forward(self, x1: Tensor, x2: Tensor, diag: bool = False, **kwargs: Any):
+            r"""
+            Computes the covariance matrix (or diagonal) without using KeOps.
+            This function must implement both the diag=True and diag=False options.
+            """
+            raise NotImplementedError
 
-        def __call__(self, *args, **kwargs):
+        @abstractmethod
+        def _keops_forward(self, x1: Tensor, x2: Tensor, **kwargs: Any):
+            r"""
+            Computes the covariance matrix with KeOps.
+            This function only implements the diag=False option, and no diag keyword should be passed in.
+            """
+            raise NotImplementedError
+
+        def forward(self, x1: Tensor, x2: Tensor, diag: bool = False, **kwargs: Any):
+            if diag:
+                return self._nonkeops_forward(x1, x2, diag=True, **kwargs)
+            elif x1.size(-2) < settings.max_cholesky_size.value() or x2.size(-2) < settings.max_cholesky_size.value():
+                return self._nonkeops_forward(x1, x2, diag=False, **kwargs)
+            else:
+                return self._keops_forward(x1, x2, **kwargs)
+
+        def __call__(self, *args: Any, **kwargs: Any):
             # Hotfix for zero gradients. See https://github.com/cornellius-gp/gpytorch/issues/1543
             args = [arg.contiguous() if torch.is_tensor(arg) else arg for arg in args]
             kwargs = {k: v.contiguous() if torch.is_tensor(v) else v for k, v in kwargs.items()}
@@ -21,5 +44,5 @@ def __call__(self, *args, **kwargs):
 except ImportError:
 
     class KeOpsKernel(Kernel):
-        def __init__(self, *args, **kwargs):
+        def __init__(self, *args: Any, **kwargs: Any):
             raise RuntimeError("You must have KeOps installed to use a KeOpsKernel")

gpytorch/kernels/keops/matern_kernel.py

@@ -2,21 +2,57 @@
 import math
 
 import torch
-from linear_operator.operators import KeOpsLinearOperator
+from linear_operator.operators import KernelLinearOperator
 
-from ... import settings
+from ..matern_kernel import MaternKernel as GMaternKernel
 from .keops_kernel import KeOpsKernel
 
 try:
     from pykeops.torch import LazyTensor as KEOLazyTensor
 
+    def _covar_func(x1, x2, nu=2.5, **params):
+        x1_ = KEOLazyTensor(x1[..., :, None, :])
+        x2_ = KEOLazyTensor(x2[..., None, :, :])
+
+        distance = ((x1_ - x2_) ** 2).sum(-1).sqrt()
+        exp_component = (-math.sqrt(nu * 2) * distance).exp()
+
+        if nu == 0.5:
+            constant_component = 1
+        elif nu == 1.5:
+            constant_component = (math.sqrt(3) * distance) + 1
+        elif nu == 2.5:
+            constant_component = (math.sqrt(5) * distance) + (1 + 5.0 / 3.0 * (distance**2))
+
+        return constant_component * exp_component
+
     class MaternKernel(KeOpsKernel):
         """
         Implements the Matern kernel using KeOps as a driver for kernel matrix multiplies.
 
-        This class can be used as a drop in replacement for gpytorch.kernels.MaternKernel in most cases, and supports
-        the same arguments. There are currently a few limitations, for example a lack of batch mode support. However,
-        most other features like ARD will work.
+        This class can be used as a drop in replacement for :class:`gpytorch.kernels.MaternKernel` in most cases,
+        and supports the same arguments.
+
+        :param nu: (Default: 2.5) The smoothness parameter.
+        :type nu: float (0.5, 1.5, or 2.5)
+        :param ard_num_dims: (Default: `None`) Set this if you want a separate lengthscale for each
+            input dimension. It should be `d` if x1 is a `... x n x d` matrix.
+        :type ard_num_dims: int, optional
+        :param batch_shape: (Default: `None`) Set this if you want a separate lengthscale for each
+             batch of input data. It should be `torch.Size([b1, b2])` for a `b1 x b2 x n x m` kernel output.
+        :type batch_shape: torch.Size, optional
+        :param active_dims: (Default: `None`) Set this if you want to
+            compute the covariance of only a few input dimensions. The ints
+            corresponds to the indices of the dimensions.
+        :type active_dims: Tuple(int)
+        :param lengthscale_prior: (Default: `None`)
+            Set this if you want to apply a prior to the lengthscale parameter.
+        :type lengthscale_prior: ~gpytorch.priors.Prior, optional
+        :param lengthscale_constraint: (Default: `Positive`) Set this if you want
+            to apply a constraint to the lengthscale parameter.
+        :type lengthscale_constraint: ~gpytorch.constraints.Interval, optional
+        :param eps: (Default: 1e-6) The minimum value that the lengthscale can take (prevents divide by zero errors).
+        :type eps: float, optional
         """
 
         has_lengthscale = True
@@ -27,8 +63,12 @@ def __init__(self, nu=2.5, **kwargs):
             super(MaternKernel, self).__init__(**kwargs)
             self.nu = nu
 
-        def _nonkeops_covar_func(self, x1, x2, diag=False):
-            distance = self.covar_dist(x1, x2, diag=diag)
+        def _nonkeops_forward(self, x1, x2, diag=False, **kwargs):
+            mean = x1.reshape(-1, x1.size(-1)).mean(0)[(None,) * (x1.dim() - 1)]
+            x1_ = (x1 - mean) / self.lengthscale
+            x2_ = (x2 - mean) / self.lengthscale
+
+            distance = self.covar_dist(x1_, x2_, diag=diag, **kwargs)
             exp_component = torch.exp(-math.sqrt(self.nu * 2) * distance)
 
             if self.nu == 0.5:
@@ -39,63 +79,14 @@ def _nonkeops_covar_func(self, x1, x2, diag=False):
                 constant_component = (math.sqrt(5) * distance).add(1).add(5.0 / 3.0 * distance**2)
             return constant_component * exp_component
 
-        def covar_func(self, x1, x2, diag=False):
-            # We only should use KeOps on big kernel matrices
-            # If we would otherwise be performing Cholesky inference, (or when just computing a kernel matrix diag)
-            # then don't apply KeOps
-            # enable gradients to ensure that test time caches on small predictions are still
-            # backprop-able
-            with torch.autograd.enable_grad():
-                if (
-                    diag
-                    or x1.size(-2) < settings.max_cholesky_size.value()
-                    or x2.size(-2) < settings.max_cholesky_size.value()
-                ):
-                    return self._nonkeops_covar_func(x1, x2, diag=diag)
-                # TODO: x1 / x2 size checks are a work around for a very minor bug in KeOps.
-                # This bug is fixed on KeOps master, and we'll remove that part of the check
-                # when they cut a new release.
-                elif x1.size(-2) == 1 or x2.size(-2) == 1:
-                    return self._nonkeops_covar_func(x1, x2, diag=diag)
-                else:
-                    # We only should use KeOps on big kernel matrices
-                    # If we would otherwise be performing Cholesky inference, then don't apply KeOps
-                    if (
-                        x1.size(-2) < settings.max_cholesky_size.value()
-                        or x2.size(-2) < settings.max_cholesky_size.value()
-                    ):
-                        x1_ = x1[..., :, None, :]
-                        x2_ = x2[..., None, :, :]
-                    else:
-                        x1_ = KEOLazyTensor(x1[..., :, None, :])
-                        x2_ = KEOLazyTensor(x2[..., None, :, :])
-
-                    distance = ((x1_ - x2_) ** 2).sum(-1).sqrt()
-                    exp_component = (-math.sqrt(self.nu * 2) * distance).exp()
-
-                    if self.nu == 0.5:
-                        constant_component = 1
-                    elif self.nu == 1.5:
-                        constant_component = (math.sqrt(3) * distance) + 1
-                    elif self.nu == 2.5:
-                        constant_component = (math.sqrt(5) * distance) + (1 + 5.0 / 3.0 * distance**2)
-
-                    return constant_component * exp_component
-
-        def forward(self, x1, x2, diag=False, **params):
+        def _keops_forward(self, x1, x2, **kwargs):
             mean = x1.reshape(-1, x1.size(-1)).mean(0)[(None,) * (x1.dim() - 1)]
-
-            x1_ = (x1 - mean).div(self.lengthscale)
-            x2_ = (x2 - mean).div(self.lengthscale)
-
-            if diag:
-                return self.covar_func(x1_, x2_, diag=True)
-
-            covar_func = lambda x1, x2, diag=False: self.covar_func(x1, x2, diag)
-            return KeOpsLinearOperator(x1_, x2_, covar_func)
+            x1_ = (x1 - mean) / self.lengthscale
+            x2_ = (x2 - mean) / self.lengthscale
+            # return KernelLinearOperator inst only when calculating the whole covariance matrix
+            return KernelLinearOperator(x1_, x2_, covar_func=_covar_func, nu=self.nu, **kwargs)
 
 except ImportError:
 
-    class MaternKernel(KeOpsKernel):
-        def __init__(self, *args, **kwargs):
-            super().__init__()
+    class MaternKernel(GMaternKernel):
+        pass

gpytorch/kernels/keops/periodic_kernel.py

@@ -0,0 +1,93 @@
+#!/usr/bin/env python3
+
+import math
+
+from linear_operator.operators import KernelLinearOperator
+
+from ..periodic_kernel import PeriodicKernel as GPeriodicKernel
+from .keops_kernel import KeOpsKernel
+
+# from ...kernels import PeriodicKernel gives a cyclic import
+
+try:
+    from pykeops.torch import LazyTensor as KEOLazyTensor
+
+    def _covar_func(x1, x2, lengthscale, **kwargs):
+        # symbolic array of shape ..., ndatax1_ x 1 x ndim
+        x1_ = KEOLazyTensor(x1[..., :, None, :])
+        # symbolic array of shape ..., 1 x ndatax2_ x ndim
+        x2_ = KEOLazyTensor(x2[..., None, :, :])
+        lengthscale = lengthscale[..., None, None, 0, :]  # 1 x 1 x ndim
+        # do not use .power(2.0) as it gives NaN values on cuda
+        # seems related to https://github.com/getkeops/keops/issues/112
+        K = ((((x1_ - x2_).abs().sin()) ** 2) * (-2.0 / lengthscale)).sum(-1).exp()
+        return K
+
+    # subclass from original periodic kernel to reduce code duplication
+    class PeriodicKernel(KeOpsKernel, GPeriodicKernel):
+        """
+        Implements the Periodic Kernel using KeOps as a driver for kernel matrix multiplies.
+
+        This class can be used as a drop in replacement for :class:`gpytorch.kernels.PeriodicKernel` in most cases,
+        and supports the same arguments.
+
+        :param ard_num_dims: (Default: `None`) Set this if you want a separate lengthscale for each
+            input dimension. It should be `d` if x1 is a `... x n x d` matrix.
+        :type ard_num_dims: int, optional
+        :param batch_shape: (Default: `None`) Set this if you want a separate lengthscale for each
+             batch of input data. It should be `torch.Size([b1, b2])` for a `b1 x b2 x n x m` kernel output.
+        :type batch_shape: torch.Size, optional
+        :param active_dims: (Default: `None`) Set this if you want to
+            compute the covariance of only a few input dimensions. The ints
+            corresponds to the indices of the dimensions.
+        :type active_dims: Tuple(int)
+        :param period_length_prior: (Default: `None`)
+            Set this if you want to apply a prior to the period length parameter.
+        :type period_length_prior: ~gpytorch.priors.Prior, optional
+        :param period_length_constraint: (Default: `Positive`) Set this if you want
+            to apply a constraint to the period length parameter.
+        :type period_length_constraint: ~gpytorch.constraints.Interval, optional
+        :param lengthscale_prior: (Default: `None`)
+            Set this if you want to apply a prior to the lengthscale parameter.
+        :type lengthscale_prior: ~gpytorch.priors.Prior, optional
+        :param lengthscale_constraint: (Default: `Positive`) Set this if you want
+            to apply a constraint to the lengthscale parameter.
+        :type lengthscale_constraint: ~gpytorch.constraints.Interval, optional
+        :param eps: (Default: 1e-6) The minimum value that the lengthscale can take (prevents divide by zero errors).
+        :type eps: float, optional
+
+        :var torch.Tensor period_length: The period length parameter. Size/shape of parameter depends on the
+            ard_num_dims and batch_shape arguments.
+        """
+
+        has_lengthscale = True
+
+        # code from the already-implemented Periodic Kernel
+        def _nonkeops_forward(self, x1, x2, diag=False, **kwargs):
+            x1_ = x1.div(self.period_length / math.pi)
+            x2_ = x2.div(self.period_length / math.pi)
+
+            # We are automatically overriding last_dim_is_batch here so that we can manually sum over dimensions.
+            diff = self.covar_dist(x1_, x2_, diag=diag, last_dim_is_batch=True)
+
+            if diag:
+                lengthscale = self.lengthscale[..., 0, :, None]
+            else:
+                lengthscale = self.lengthscale[..., 0, :, None, None]
+
+            exp_term = diff.sin().pow(2.0).div(lengthscale).mul(-2.0)
+            exp_term = exp_term.sum(dim=(-2 if diag else -3))
+
+            return exp_term.exp()
+
+        def _keops_forward(self, x1, x2, **kwargs):
+            x1_ = x1.div(self.period_length / math.pi)
+            x2_ = x2.div(self.period_length / math.pi)
+            # return KernelLinearOperator inst only when calculating the whole covariance matrix
+            # pass any parameters which are used inside _covar_func as *args to get gradients computed for them
+            return KernelLinearOperator(x1_, x2_, lengthscale=self.lengthscale, covar_func=_covar_func, **kwargs)
+
+except ImportError:
+
+    class PeriodicKernel(GPeriodicKernel):
+        pass