diff learner.py @ 109:d97f6fe6bdf9

Merged with this morning unsaved edits
author bengioy@bengiomac.local
date Tue, 06 May 2008 20:01:34 -0400
parents c4916445e025
children 8fa1ef2411a0
line wrap: on
line diff
--- a/learner.py	Tue May 06 19:55:29 2008 -0400
+++ b/learner.py	Tue May 06 20:01:34 2008 -0400
@@ -153,6 +153,16 @@
         @todo check if some of the learner attributes are actually SPECIFIED
         as attributes of the input_dataset, and if so use their values instead
         of the ones in the learner.
+
+        The learner tries to compute in the output dataset the output fields specified.
+        If None is specified then self.defaultOutputFields(input_dataset.fieldNames())
+        is called to determine the output fields.
+
+        Attributes of the learner can also optionally be copied into the output dataset.
+        If output_attributes is None then all of the attributes in self.AttributeNames()
+        are copied in the output dataset, but if it is [] (the default), then none are copied.
+        If a test_stats_collector is provided, then its attributes (test_stats_collector.AttributeNames())
+        are also copied into the output dataset attributes.
         """
         minibatchwise_use_function = _minibatchwise_use_functions(input_dataset.fieldNames(),
                                                                   output_fieldnames,