r5741 - /1.3/generic_fns/model_selection.py -- April 15, 2008 - 23:11

Author: bugman
Date: Tue Apr 15 23:11:13 2008
New Revision: 5741

URL: http://svn.gna.org/viewcvs/relax?rev=5741&view=rev
Log:
Converted the select() method docstring to epydoc format.


Modified:
    1.3/generic_fns/model_selection.py

Modified: 1.3/generic_fns/model_selection.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/model_selection.py?rev=5741&r1=5740&r2=5741&view=diff
==============================================================================
--- 1.3/generic_fns/model_selection.py (original)
+++ 1.3/generic_fns/model_selection.py Tue Apr 15 23:11:13 2008
@@ -98,7 +98,21 @@
 
 
 def select(method=None, modsel_pipe=None, pipes=None):
-    """Model selection function."""
+    """Model selection function.
+
+    @keyword method:        The model selection method.  This can currently 
be one of:
+                                - 'AIC', Akaike's Information Criteria.
+                                - 'AICc', Small sample size corrected AIC.
+                                - 'BIC', Bayesian or Schwarz Information 
Criteria.
+                                - 'CV', Single-item-out cross-validation.
+                            None of the other model selection techniques are 
currently supported.
+    @type method:           str
+    @keyword modsel_pipe:   The name of the new data pipe to be created by 
copying of the selected
+                            data pipe.
+    @type modsel_pipe:      str
+    @keyword pipes:         A list of the data pipes to use in the model 
selection.
+    @type pipes:            list of str
+    """
 
     # Use all pipes (but the current).
     if pipes == None: