Merge pull request #359 from amueller/add_evaluations_to_apidoc

Update api docs, list evaluations

Author: mfeurer

doc/api.rst

@@ -18,6 +18,7 @@ Top-level Classes
    OpenMLTask
    OpenMLSplit
    OpenMLFlow
+   OpenMLEvaluation
 
 
 :mod:`openml.datasets`: Dataset Functions
@@ -43,12 +44,18 @@ Top-level Classes
 
    run_task
    get_run
+   get_runs
    list_runs
    list_runs_by_flow
    list_runs_by_tag
    list_runs_by_task
    list_runs_by_uploader
    list_runs_by_filters
+   run_model_on_task
+   run_flow_on_task
+   get_run_trace
+   initialize_model_from_run
+   initialize_model_from_trace
 
 :mod:`openml.tasks`: Task Functions
 -----------------------------------
@@ -59,6 +66,7 @@ Top-level Classes
    :template: function.rst
 
     get_task
+    get_tasks
     list_tasks
 
 :mod:`openml.flows`: Flow Functions
@@ -68,4 +76,18 @@ Top-level Classes
 .. autosummary::
    :toctree: generated/
    :template: function.rst
+
+    get_flow
+    list_flows
+    flow_exists
+ 
+:mod:`openml.flows`: Evaluation Functions
+-----------------------------------------
+.. currentmodule:: openml.evaluation
+
+.. autosummary::
+   :toctree: generated/
+   :template: function.rst
+
+    list_evaluations
 

openml/evaluations/evaluation.py

@@ -21,7 +21,8 @@ class OpenMLEvaluation(object):
         value : float
             the value of this evaluation
         array_data : str
-            list of information per class (e.g., in case of precision, auroc, recall)
+            list of information per class (e.g., in case of precision, auroc,
+            recall)
     '''
     def __init__(self, run_id, task_id, setup_id, flow_id, flow_name,
                  data_id, data_name, function, upload_time, value,
@@ -37,4 +38,3 @@ def __init__(self, run_id, task_id, setup_id, flow_id, flow_name,
         self.upload_time = upload_time
         self.value = value
         self.array_data = array_data
-

openml/evaluations/functions.py

@@ -3,8 +3,9 @@
 from .._api_calls import _perform_api_call
 from ..evaluations import OpenMLEvaluation
 
-def list_evaluations(function, offset=None, size=None, id=None, task=None, setup=None,
-              flow=None, uploader=None, tag=None):
+
+def list_evaluations(function, offset=None, size=None, id=None, task=None,
+                     setup=None, flow=None, uploader=None, tag=None):
     """List all run-evaluation pairs matching all of the given filters.
 
         Perform API call `/evaluation/function{function}/{filters}