diff --git a/GPy/kern/__init__.py b/GPy/kern/__init__.py index a5fd01ad..33301817 100644 --- a/GPy/kern/__init__.py +++ b/GPy/kern/__init__.py @@ -1,15 +1,26 @@ """ +Introduction +^^^^^^^^^^^^ -In terms of Gaussian Processes, a kernel is a function that specifies the degree of similarity between variables given their relative positions in parameter space. If known variables *x* and *x'* are close together then observed variables *y* and *y'* may also be similar, depending on the kernel function and its parameters. +In terms of Gaussian Processes, a kernel is a function that specifies the degree of similarity between variables given their relative positions in parameter space. If known variables *x* and *x'* are close together then observed variables *y* and *y'* may also be similar, depending on the kernel function and its parameters. *Note: this may be too simple a definition for the broad range of kernels available in :py:class:`GPy`.* :py:class:`GPy.kern.src.kern.Kern` is a generic kernel object inherited by more specific, end-user kernels used in models. It provides methods that specific kernels should generally have such as :py:class:`GPy.kern.src.kern.Kern.K` to compute the value of the kernel, :py:class:`GPy.kern.src.kern.Kern.add` to combine kernels and numerous functions providing information on kernel gradients. -.. inheritance-diagram:: GPy.kern.src.kern.Kern +There are several inherited types of kernel that provide a basis for specific end user kernels: + +.. inheritance-diagram:: GPy.kern.src.kern.Kern GPy.kern.src.static GPy.kern.src.stationary GPy.kern.src.kern.CombinationKernel GPy.kern.src.brownian GPy.kern.src.linear GPy.kern.src.standard_periodic + :top-classes: GPy.core.parameterization.parameterized.Parameterized + +e.g. the archetype :py:class:`GPy.kern.RBF` does not inherit directly from :py:class:`GPy.kern.src.kern.Kern`, but from :py:class:`GPy.kern.src.stationary`. + +.. inheritance-diagram:: GPy.kern.src.kern.Kern GPy.kern.RBF :top-classes: GPy.core.parameterization.parameterized.Parameterized """ + + from .src.kern import Kern from .src.add import Add from .src.prod import Prod