typos, minor refactoring

Author: mfeurer

openml/_api_calls.py

@@ -51,7 +51,7 @@ def _read_url(self, url, add_authentication=False, data=None, filePath=None):
     return _read_url(url, data)
 
 
-def fileid_to_url(file_id, filename=None):
+def _file_id_to_url(file_id, filename=None):
     '''
      Presents the URL how to download a given file id
      filename is optional

openml/runs/functions.py

@@ -17,7 +17,7 @@
 
 from ..exceptions import OpenMLCacheException, OpenMLServerException
 from ..util import URLError, version_complies
-from .._api_calls import _perform_api_call, fileid_to_url
+from .._api_calls import _perform_api_call, _file_id_to_url
 from .run import OpenMLRun, _get_version_information
 from .trace import OpenMLRunTrace, OpenMLTraceIteration
 
@@ -99,6 +99,17 @@ def run_task(task, model, avoid_duplicate_runs=True, flow_tags=None, seed=None):
 
 
 def get_run_trace(run_id):
+    """Get the optimization trace object for a given run id.
+
+     Parameters
+     ----------
+     run_id : int
+
+     Returns
+     -------
+     openml.runs.OpenMLTrace
+    """
+
     trace_xml = _perform_api_call('run/trace/%d' % run_id)
     run_trace = _create_trace_from_description(trace_xml)
     return run_trace
@@ -124,7 +135,7 @@ def initialize_model_from_run(run_id):
 
 def initialize_model_from_trace(run_id, repeat, fold, iteration=None):
     '''
-    Initialized a model based on the parameters that were set
+    Initialize a model based on the parameters that were set
     by an optimization procedure (i.e., using the exact same
     parameter settings)
 
@@ -146,7 +157,7 @@ def initialize_model_from_trace(run_id, repeat, fold, iteration=None):
     Returns
     -------
     model : sklearn model
-        the scikitlearn model with all parameters initailized
+        the scikit-learn model with all parameters initailized
     '''
     run_trace = get_run_trace(run_id)
 

openml/runs/trace.py

@@ -5,7 +5,11 @@ class OpenMLRunTrace(object):
 
     Parameters
     ----------
-    FIXME
+    run_id : int
+
+    trace_iterations : dict
+        Mapping from key ``(repeat, fold, iteration)`` to an object of
+        OpenMLTraceIteration.
 
     """
 
@@ -28,7 +32,17 @@ class OpenMLTraceIteration(object):
 
     Parameters
     ----------
-    FIXME
+    repeat : int
+
+    fold : int
+
+    iteration : int
+
+    setup_string : FIXME
+
+    evaluation : FIXME
+
+    selected : FIXME
     """
 
     def __init__(self, repeat, fold, iteration, setup_string, evaluation, selected):

tests/test_runs/test_run_functions.py

@@ -36,7 +36,7 @@ def _check_serialized_optimized_run(self, run_id):
         # TODO: assert holdout task
 
         # downloads the predictions of the old task
-        predictions_url = openml._api_calls.fileid_to_url(run.output_files['predictions'])
+        predictions_url = openml._api_calls._file_id_to_url(run.output_files['predictions'])
         predictions = arff.loads(openml._api_calls._read_url(predictions_url))
 
         # downloads the best model based on the optimization trace