apunkt/GPy
1
0
Fork 0
mirror of https://github.com/SheffieldML/GPy.git synced 2026-06-02 14:45:15 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

initial core docs, class diagram

Browse source
This commit is contained in:
bobturneruk 2020-04-03 16:45:24 +01:00
parent 07371cd777
commit 59a7742a9c
4 changed files with 30 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
GPy/core/__init__.py
View file

@ -2,7 +2,21 @@
# Licensed under the BSD 3-clause license (see LICENSE.txt)
"""
This module does...
This module contains the fundamental classes of GPy - classes that are inherited by objects in other parts of GPy in order to provide a consistent interface to major functionality.
.. inheritance-diagram:: GPy.core.gp.GP
:top-classes: paramz.core.parameter_core.Parameterizable
:py:class:`GPy.core.model` is inherited by :py:class:`GPy.core.gp.GP`. And :py:class:`GPy.core.model` itself inherits :py:class:`paramz.model.Model` from the `paramz` package. `paramz` essentially provides an inherited set of properties and functions used to manage state (and state changes) of the model.
:py:class:`GPy.core.gp.GP` represents a GP model. Such an entity is typically passed variables representing known (x) and observed (y) data, along with a kernel and other information needed to create the specific model. It exposes functions which return information derived from the inputs to the model, for example predicting unobserved variables based on new known variables, or the log marginal likelihood of the current state of the model.
:py:func:`~GPy.core.gp.GP.optimize` is called to optimize hyperparameters of the model. The optimizer argument takes a string which is used to specify non-default optimization schemes.
Various plotting functions can be called against :py:class:`GPy.core.gp.GP`.
:py:class:`GPy.core.gp.GP` is inherited by :py:class:`GPy.core.gp_grid`, :py:class:`GPy.core.sparse_gp`, different types of GP model.
"""