From 25635571afe8517d97c23196cd309db8f9d5fc9d Mon Sep 17 00:00:00 2001 From: Max Zwiessele Date: Thu, 28 Nov 2013 10:31:17 +0000 Subject: [PATCH] added comments for models module and adjusted setup --- GPy/models.py | 12 ++++++++++-- doc/index.rst | 3 +++ setup.py | 2 +- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/GPy/models.py b/GPy/models.py index 8a1d046c..3b2683ea 100644 --- a/GPy/models.py +++ b/GPy/models.py @@ -1,9 +1,17 @@ ''' -Created on 14 Nov 2013 +GPy Models +========== -@author: maxz +Implementations for common models used in GP regression and classification. +The different models can be viewed in :mod:`GPy.models_modules`, which holds +detailed explanations for the different models. + +:warning: This module is a convienince module for endusers to use. For developers +see :mod:`GPy.models_modules`, which holds the implementions for each model. ''' +__updated__ = '2013-11-28' + from models_modules.bayesian_gplvm import BayesianGPLVM from models_modules.gp_regression import GPRegression from models_modules.gp_classification import GPClassification#; _gp_classification = gp_classification ; del gp_classification diff --git a/doc/index.rst b/doc/index.rst index 29b4cf43..f6207963 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -15,6 +15,9 @@ For a quick start, you can have a look at one of the tutorials: You may also be interested by some examples in the GPy/examples folder. +The detailed Developers Documentation is listed below +===================================================== + Contents: .. toctree:: diff --git a/setup.py b/setup.py index 88ee6257..3b493022 100644 --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ setup(name = 'GPy', license = "BSD 3-clause", keywords = "machine-learning gaussian-processes kernels", url = "http://sheffieldml.github.com/GPy/", - packages = ['GPy', 'GPy.core', 'GPy.kern', 'GPy.util', 'GPy._models', 'GPy.inference', 'GPy.examples', 'GPy.likelihoods', 'GPy.testing', 'GPy.util.latent_space_visualizations', 'GPy.util.latent_space_visualizations.controllers', 'GPy.likelihoods.noise_models', 'GPy.kern.parts', 'GPy.mappings'], + packages = ['GPy', 'GPy.core', 'GPy.kern', 'GPy.util', 'GPy.models_modules', 'GPy.inference', 'GPy.examples', 'GPy.likelihoods', 'GPy.testing', 'GPy.util.latent_space_visualizations', 'GPy.util.latent_space_visualizations.controllers', 'GPy.likelihoods.noise_models', 'GPy.kern.parts', 'GPy.mappings'], package_dir={'GPy': 'GPy'}, package_data = {'GPy': ['GPy/examples', 'gpy_config.cfg']}, py_modules = ['GPy.__init__'],