diff --git a/doc/Figures/tuto_kern_overview_basicdef.png b/doc/Figures/tuto_kern_overview_basicdef.png index bad43b09..7a963228 100644 Binary files a/doc/Figures/tuto_kern_overview_basicdef.png and b/doc/Figures/tuto_kern_overview_basicdef.png differ diff --git a/doc/GPy.inference.rst b/doc/GPy.inference.rst index 357e70c7..f30e7d25 100644 --- a/doc/GPy.inference.rst +++ b/doc/GPy.inference.rst @@ -1,6 +1,14 @@ inference Package ================= +:mod:`SGD` Module +----------------- + +.. automodule:: GPy.inference.SGD + :members: + :undoc-members: + :show-inheritance: + :mod:`optimization` Module -------------------------- diff --git a/doc/GPy.kern.rst b/doc/GPy.kern.rst index d6593939..a3a611b7 100644 --- a/doc/GPy.kern.rst +++ b/doc/GPy.kern.rst @@ -113,6 +113,14 @@ kern Package :undoc-members: :show-inheritance: +:mod:`product` Module +--------------------- + +.. automodule:: GPy.kern.product + :members: + :undoc-members: + :show-inheritance: + :mod:`product_orthogonal` Module -------------------------------- diff --git a/doc/tuto_kernel_overview.rst b/doc/tuto_kernel_overview.rst index 80e2bee2..7d76bfdd 100644 --- a/doc/tuto_kernel_overview.rst +++ b/doc/tuto_kernel_overview.rst @@ -13,17 +13,25 @@ First we import the libraries we will need :: For most kernels, the dimension is the only mandatory parameter to define a kernel object. However, it is also possible to specify the values of the parameters. For example, the three following commands are valid for defining a squared exponential kernel (ie rbf or Gaussian) :: ker1 = GPy.kern.rbf(1) # Equivalent to ker1 = GPy.kern.rbf(D=1, variance=1., lengthscale=1.) - ker2 = GPy.kern.rbf(D=1, variance = 1.5, lengthscale=2.) + ker2 = GPy.kern.rbf(D=1, variance = .75, lengthscale=2.) ker3 = GPy.kern.rbf(1, .5, .5) -A `plot` and a `print` functions are implemented to represent kernel objects :: +A ``print`` and a ``plot`` functions are implemented to represent kernel objects. The commands :: - print ker1 + print ker2 ker1.plot() ker2.plot() ker3.plot() +should return:: + + Name | Value | Constraints | Ties + ------------------------------------------------------- + rbf_variance | 1.0000 | | + rbf_lengthscale | 1.0000 | | + + .. figure:: Figures/tuto_kern_overview_basicdef.png :align: center :height: 350px