added some documentation and example files

This commit is contained in:
Nicolas 2013-01-21 12:16:55 +00:00
parent b2237b93e6
commit eedf1f99d1
8 changed files with 380 additions and 0 deletions

0
GPy/examples/__init__.py Normal file
View file

35
doc/GPy.core.rst Normal file
View file

@ -0,0 +1,35 @@
core Package
============
:mod:`core` Package
-------------------
.. automodule:: GPy.core
:members:
:undoc-members:
:show-inheritance:
:mod:`model` Module
-------------------
.. automodule:: GPy.core.model
:members:
:undoc-members:
:show-inheritance:
:mod:`parameterised` Module
---------------------------
.. automodule:: GPy.core.parameterised
:members:
:undoc-members:
:show-inheritance:
:mod:`priors` Module
--------------------
.. automodule:: GPy.core.priors
:members:
:undoc-members:
:show-inheritance:

35
doc/GPy.inference.rst Normal file
View file

@ -0,0 +1,35 @@
inference Package
=================
:mod:`Expectation_Propagation` Module
-------------------------------------
.. automodule:: GPy.inference.Expectation_Propagation
:members:
:undoc-members:
:show-inheritance:
:mod:`likelihoods` Module
-------------------------
.. automodule:: GPy.inference.likelihoods
:members:
:undoc-members:
:show-inheritance:
:mod:`optimization` Module
--------------------------
.. automodule:: GPy.inference.optimization
:members:
:undoc-members:
:show-inheritance:
:mod:`samplers` Module
----------------------
.. automodule:: GPy.inference.samplers
:members:
:undoc-members:
:show-inheritance:

139
doc/GPy.kern.rst Normal file
View file

@ -0,0 +1,139 @@
kern Package
============
:mod:`kern` Package
-------------------
.. automodule:: GPy.kern
:members:
:undoc-members:
:show-inheritance:
:mod:`Brownian` Module
----------------------
.. automodule:: GPy.kern.Brownian
:members:
:undoc-members:
:show-inheritance:
:mod:`Matern32` Module
----------------------
.. automodule:: GPy.kern.Matern32
:members:
:undoc-members:
:show-inheritance:
:mod:`Matern52` Module
----------------------
.. automodule:: GPy.kern.Matern52
:members:
:undoc-members:
:show-inheritance:
:mod:`bias` Module
------------------
.. automodule:: GPy.kern.bias
:members:
:undoc-members:
:show-inheritance:
:mod:`constructors` Module
--------------------------
.. automodule:: GPy.kern.constructors
:members:
:undoc-members:
:show-inheritance:
:mod:`exponential` Module
-------------------------
.. automodule:: GPy.kern.exponential
:members:
:undoc-members:
:show-inheritance:
:mod:`finite_dimensional` Module
--------------------------------
.. automodule:: GPy.kern.finite_dimensional
:members:
:undoc-members:
:show-inheritance:
:mod:`kern` Module
------------------
.. automodule:: GPy.kern.kern
:members:
:undoc-members:
:show-inheritance:
:mod:`kernpart` Module
----------------------
.. automodule:: GPy.kern.kernpart
:members:
:undoc-members:
:show-inheritance:
:mod:`linear` Module
--------------------
.. automodule:: GPy.kern.linear
:members:
:undoc-members:
:show-inheritance:
:mod:`linear_ARD` Module
------------------------
.. automodule:: GPy.kern.linear_ARD
:members:
:undoc-members:
:show-inheritance:
:mod:`rbf-testing` Module
-------------------------
.. automodule:: GPy.kern.rbf-testing
:members:
:undoc-members:
:show-inheritance:
:mod:`rbf` Module
-----------------
.. automodule:: GPy.kern.rbf
:members:
:undoc-members:
:show-inheritance:
:mod:`spline` Module
--------------------
.. automodule:: GPy.kern.spline
:members:
:undoc-members:
:show-inheritance:
:mod:`sympykern` Module
-----------------------
.. automodule:: GPy.kern.sympykern
:members:
:undoc-members:
:show-inheritance:
:mod:`white` Module
-------------------
.. automodule:: GPy.kern.white
:members:
:undoc-members:
:show-inheritance:

75
doc/GPy.models.rst Normal file
View file

@ -0,0 +1,75 @@
models Package
==============
:mod:`models` Package
---------------------
.. automodule:: GPy.models
:members:
:undoc-members:
:show-inheritance:
:mod:`GPLVM` Module
-------------------
.. automodule:: GPy.models.GPLVM
:members:
:undoc-members:
:show-inheritance:
:mod:`GP_EP` Module
-------------------
.. automodule:: GPy.models.GP_EP
:members:
:undoc-members:
:show-inheritance:
:mod:`GP_regression` Module
---------------------------
.. automodule:: GPy.models.GP_regression
:members:
:undoc-members:
:show-inheritance:
:mod:`generalized_FITC` Module
------------------------------
.. automodule:: GPy.models.generalized_FITC
:members:
:undoc-members:
:show-inheritance:
:mod:`sparse_GPLVM` Module
--------------------------
.. automodule:: GPy.models.sparse_GPLVM
:members:
:undoc-members:
:show-inheritance:
:mod:`sparse_GP_regression` Module
----------------------------------
.. automodule:: GPy.models.sparse_GP_regression
:members:
:undoc-members:
:show-inheritance:
:mod:`uncollapsed_sparse_GP` Module
-----------------------------------
.. automodule:: GPy.models.uncollapsed_sparse_GP
:members:
:undoc-members:
:show-inheritance:
:mod:`warped_GP` Module
-----------------------
.. automodule:: GPy.models.warped_GP
:members:
:undoc-members:
:show-inheritance:

22
doc/GPy.rst Normal file
View file

@ -0,0 +1,22 @@
GPy Package
===========
:mod:`GPy` Package
------------------
.. automodule:: GPy.__init__
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
GPy.core
GPy.inference
GPy.kern
GPy.models
GPy.util

67
doc/GPy.util.rst Normal file
View file

@ -0,0 +1,67 @@
util Package
============
:mod:`util` Package
-------------------
.. automodule:: GPy.util
:members:
:undoc-members:
:show-inheritance:
:mod:`Tango` Module
-------------------
.. automodule:: GPy.util.Tango
:members:
:undoc-members:
:show-inheritance:
:mod:`datasets` Module
----------------------
.. automodule:: GPy.util.datasets
:members:
:undoc-members:
:show-inheritance:
:mod:`linalg` Module
--------------------
.. automodule:: GPy.util.linalg
:members:
:undoc-members:
:show-inheritance:
:mod:`misc` Module
------------------
.. automodule:: GPy.util.misc
:members:
:undoc-members:
:show-inheritance:
:mod:`plot` Module
------------------
.. automodule:: GPy.util.plot
:members:
:undoc-members:
:show-inheritance:
:mod:`squashers` Module
-----------------------
.. automodule:: GPy.util.squashers
:members:
:undoc-members:
:show-inheritance:
:mod:`warping_functions` Module
-------------------------------
.. automodule:: GPy.util.warping_functions
:members:
:undoc-members:
:show-inheritance:

7
doc/modules.rst Normal file
View file

@ -0,0 +1,7 @@
GPy
===
.. toctree::
:maxdepth: 4
GPy