diff --git a/doc/Figures/tick.png b/doc/Figures/tick.png new file mode 100644 index 00000000..1175c802 Binary files /dev/null and b/doc/Figures/tick.png differ diff --git a/doc/GPy.examples.rst b/doc/GPy.examples.rst index 59ffd43d..ec283d21 100644 --- a/doc/GPy.examples.rst +++ b/doc/GPy.examples.rst @@ -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 ------------------------------------------------ diff --git a/doc/GPy.kern.rst b/doc/GPy.kern.rst index a3a611b7..3ebeda40 100644 --- a/doc/GPy.kern.rst +++ b/doc/GPy.kern.rst @@ -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 ----------------------- diff --git a/doc/kernel_implementation.rst b/doc/kernel_implementation.rst index 57b37c8e..888d1ee5 100644 --- a/doc/kernel_implementation.rst +++ b/doc/kernel_implementation.rst @@ -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 diff --git a/doc/tuto_kernel_overview.rst b/doc/tuto_kernel_overview.rst index c420943b..e410696a 100644 --- a/doc/tuto_kernel_overview.rst +++ b/doc/tuto_kernel_overview.rst @@ -39,7 +39,7 @@ return:: Implemented kernels =================== -Many kernels are already implemented in GPy. A comprehensive list can be found `here `_ . The following figure gives a summary of most of them: +Many kernels are already implemented in GPy. A comprehensive list can be found `here `_ and the following figure gives a summary of most of them: .. figure:: Figures/tuto_kern_overview_allkern.png :align: center