From 159ca2eba691e06ccde274b33ea19f736ac1965d Mon Sep 17 00:00:00 2001 From: bobturneruk Date: Tue, 12 May 2020 13:44:03 +0100 Subject: [PATCH] more on examples --- GPy/examples/__init__.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/GPy/examples/__init__.py b/GPy/examples/__init__.py index 4c5929f1..d0636ea8 100644 --- a/GPy/examples/__init__.py +++ b/GPy/examples/__init__.py @@ -1,10 +1,16 @@ # Copyright (c) 2012-2014, GPy authors (see AUTHORS.txt). # Licensed under the BSD 3-clause license (see LICENSE.txt) """ -Examples for GPy. +Introduction +^^^^^^^^^^^^ The examples in this package usually depend on `pods `_ so make sure you have that installed before running examples. The easiest way to do this is to run `pip install pods`. `pods` enables access to 3rd party data required for most of the examples. + +The examples are executable and self-contained workflows in that they have their own source data, create their own models, kernels and other objects as needed, execute optimisation as required, and display output. + +Viewing the source code of each model will clarify the steps taken in its execution, and may provide inspiration for developing of user-specific applications of `GPy`. + """ from . import classification from . import regression