updated code comments based om @mfeurers requests

Author: janvanrijn

openml/runs/functions.py

@@ -133,6 +133,7 @@ def initialize_model_from_run(run_id):
     run = get_run(run_id)
     return initialize_model(run.setup_id)
 
+
 def initialize_model_from_trace(run_id, repeat, fold, iteration=None):
     '''
     Initialize a model based on the parameters that were set
@@ -142,7 +143,8 @@ def initialize_model_from_trace(run_id, repeat, fold, iteration=None):
     Parameters
     ----------
     run_id : int
-        The Openml run_id. Should contain a trace file
+        The Openml run_id. Should contain a trace file, 
+        otherwise a OpenMLServerException is raised
 
     repeat: int
         The repeat nr (column in trace file)
@@ -152,7 +154,9 @@ def initialize_model_from_trace(run_id, repeat, fold, iteration=None):
 
     iteration: int
         The iteration nr (column in trace file). If None, the
-        best (selected) iteration will be searched (slow)
+        best (selected) iteration will be searched (slow), 
+        according to the selection criteria implemented in
+        OpenMLRunTrace.get_selected_iteration
 
     Returns
     -------

openml/runs/trace.py

@@ -18,8 +18,13 @@ def __init__(self, run_id, trace_iterations):
         self.trace_iterations = trace_iterations
 
     def get_selected_iteration(self, fold, repeat):
+        '''
+        Returns the trace iteration that was marked as selected. In
+        case multiple are marked as selected (should not happen) the
+        first of these is returned
+        '''
         for (r, f, i) in self.trace_iterations:
-            if r == repeat and f == fold and self.trace_iterations[(r, f, i)].selected == True:
+            if r == repeat and f == fold and self.trace_iterations[(r, f, i)].selected is True:
                 return i
         raise ValueError('Could not find the selected iteration for rep/fold %d/%d' %(repeat,fold))
 
@@ -64,6 +69,9 @@ def get_parameters(self):
         return result
 
     def __str__(self):
+        '''
+        tmp string representation, will be changed in the near future 
+        '''
         return '[(%d,%d,%d): %f (%r)]' %(self.repeat, self.fold, self.iteration,
                                           self.evaluation, self.selected)