From 26260c355c7d3c247cd6d23f9d98f189e406ecb6 Mon Sep 17 00:00:00 2001 From: Max Zwiessele Date: Thu, 27 Jun 2013 10:40:23 +0100 Subject: [PATCH] added docstring to domains --- GPy/core/domains.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/GPy/core/domains.py b/GPy/core/domains.py index dfc880f6..cefac6c2 100644 --- a/GPy/core/domains.py +++ b/GPy/core/domains.py @@ -2,6 +2,22 @@ Created on 4 Jun 2013 @author: maxz + +(Hyper-)Parameter domains defined for :py:mod:`~GPy.core.priors` and :py:mod:`~GPy.kern`. +These domains specify the legitimate realm of the parameters to live in. + +:const:`~GPy.core.domains.REAL` : + real domain, all values in the real numbers are allowed + +:const:`~GPy.core.domains.POSITIVE`: + positive domain, only positive real values are allowed + +:const:`~GPy.core.domains.NEGATIVE`: + same as :const:`~GPy.core.domains.POSITIVE`, but only negative values are allowed + +:const:`~GPy.core.domains.BOUNDED`: + only values within the bounded range are allowed, + the bounds are specified withing the object with the bounded range ''' REAL = 'real'