apunkt/GPy
1
0
Fork 0
mirror of https://github.com/SheffieldML/GPy.git synced 2026-04-27 13:56:23 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

added in documentation the current status of kernel implementation

Browse source
This commit is contained in:
Nicolas 2013-03-11 12:40:29 +00:00
parent e9c84484c0
commit e511bb69cf
5 changed files with 70 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
doc/Figures/tick.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 175 B

16
doc/GPy.examples.rst
View file

@ -73,6 +73,22 @@ examples Package
:undoc-members:
:show-inheritance:
:mod:`tuto_GP_regression` Module
--------------------------------
.. automodule:: GPy.examples.tuto_GP_regression
:members:
:undoc-members:
:show-inheritance:
:mod:`tuto_kernel_overview` Module
----------------------------------
.. automodule:: GPy.examples.tuto_kernel_overview
:members:
:undoc-members:
:show-inheritance:
:mod:`uncertain_input_GP_regression_demo` Module
------------------------------------------------

28
doc/GPy.kern.rst
View file

@ -49,6 +49,14 @@ kern Package
:undoc-members:
:show-inheritance:
:mod:`coregionalise` Module
---------------------------
.. automodule:: GPy.kern.coregionalise
:members:
:undoc-members:
:show-inheritance:
:mod:`exponential` Module
-------------------------
@ -113,18 +121,18 @@ kern Package
:undoc-members:
:show-inheritance:
:mod:`product` Module
---------------------
:mod:`prod` Module
------------------
.. automodule:: GPy.kern.product
.. automodule:: GPy.kern.prod
:members:
:undoc-members:
:show-inheritance:
:mod:`product_orthogonal` Module
--------------------------------
:mod:`prod_orthogonal` Module
-----------------------------
.. automodule:: GPy.kern.product_orthogonal
.. automodule:: GPy.kern.prod_orthogonal
:members:
:undoc-members:
:show-inheritance:
@ -145,6 +153,14 @@ kern Package
:undoc-members:
:show-inheritance:
:mod:`symmetric` Module
-----------------------
.. automodule:: GPy.kern.symmetric
:members:
:undoc-members:
:show-inheritance:
:mod:`sympykern` Module
-----------------------

41
doc/kernel_implementation.rst
View file

@ -3,15 +3,36 @@
List of implemented kernels
***************************
The :math:`\checkmark` symbol represents the functions that have been implemented for each kernel.
The following table shows the implemented kernels in GPy and gives the details of the implemented function for each kernel.
.. |tick|
==================== =========== ====== ======= =========== =============== ======= =========== ====== ====== =======
NAME get/set K Kdiag dK_dtheta dKdiag_dtheta dK_dX dKdiag_dX psi0 psi1 psi2
==================== =========== ====== ======= =========== =============== ======= =========== ====== ====== =======
bias |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
Brownian |tick| |tick| |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
exponential |tick| |tick| |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
finite_dimensional |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
linear |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
Matern32 |tick| |tick| |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
Matern52 |tick| |tick| |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
periodic_exponential |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
periodic_Matern32 |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
periodic_Matern52 |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
rbf |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
spline |tick| |tick| |tick| |tick| |tick| |tick|
-------------------- ----------- ------ ------- ----------- --------------- ------- ----------- ------ ------ -------
white |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick| |tick|
==================== =========== ====== ======= =========== =============== ======= =========== ====== ====== =======
.. |tick| image:: tick.png
====== =========== === ======= =========== =============== ======= =========== ====== ====== =======
NAME get/set K Kdiag dK_dtheta dKdiag_dtheta dK_dX dKdiag_dX psi0 psi1 psi2
====== =========== === ======= =========== =============== ======= =========== ====== ====== =======
rbf \\checkmark y
====== =========== === ======= =========== =============== ======= =========== ====== ====== =======
.. |tick| image:: Figures/tick.png

2
doc/tuto_kernel_overview.rst
View file

@ -39,7 +39,7 @@ return::
Implemented kernels
===================
Many kernels are already implemented in GPy. A comprehensive list can be found `here <kernel_implementation.html>`_ . The following figure gives a summary of most of them:
Many kernels are already implemented in GPy. A comprehensive list can be found `here <kernel_implementation.html>`_ and the following figure gives a summary of most of them:
.. figure:: Figures/tuto_kern_overview_allkern.png
:align: center