From 27ccdc74ee4c23dc898508d4d3d3986336b2856c Mon Sep 17 00:00:00 2001 From: bobturneruk Date: Wed, 22 Apr 2020 11:24:36 +0100 Subject: [PATCH] moved doc back from kern.src to kern --- GPy/kern/__init__.py | 11 +++++++++++ GPy/kern/src/__init__.py | 8 -------- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/GPy/kern/__init__.py b/GPy/kern/__init__.py index 5ed58e83..a5fd01ad 100644 --- a/GPy/kern/__init__.py +++ b/GPy/kern/__init__.py @@ -1,4 +1,15 @@ +""" + +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. + +: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 + :top-classes: GPy.core.parameterization.parameterized.Parameterized + +""" + from .src.kern import Kern from .src.add import Add from .src.prod import Prod diff --git a/GPy/kern/src/__init__.py b/GPy/kern/src/__init__.py index 4056bf42..2d81d9b6 100644 --- a/GPy/kern/src/__init__.py +++ b/GPy/kern/src/__init__.py @@ -1,10 +1,2 @@ -""" - -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. - -.. inheritance-diagram:: GPy.kern.src.kern.Kern - :top-classes: GPy.core.parameterization.parameterized.Parameterized - -""" from . import psi_comp