initial commit for setup list

Author: janvanrijn

openml/__init__.py

@@ -22,6 +22,7 @@
 from . import runs
 from . import flows
 from . import setups
+from . import evaluations
 from .runs import OpenMLRun
 from .tasks import OpenMLTask, OpenMLSplit
 from .flows import OpenMLFlow
@@ -66,5 +67,6 @@ def populate_cache(task_ids=None, dataset_ids=None, flow_ids=None,
 
 
 __all__ = ['OpenMLDataset', 'OpenMLDataFeature', 'OpenMLRun',
-           'OpenMLSplit', 'datasets', 'OpenMLTask', 'OpenMLFlow',
+           'OpenMLSplit', 'OpenMLEvaluation', 'OpenMLSetup',
+           'OpenMLTask', 'OpenMLFlow', 'datasets', 'evaluations',
            'config', 'runs', 'flows', 'tasks', 'setups']

openml/setups/__init__.py

@@ -1,3 +1,4 @@
-from .functions import get_setup, setup_exists, initialize_model
+from .setup import OpenMLSetup
+from .functions import get_setup, setup_list, setup_exists, initialize_model
 
-__all__ = ['get_setup', 'setup_exists', 'initialize_model']
+__all__ = ['get_setup', 'setup_list', 'setup_exists', 'initialize_model']

openml/setups/functions.py

@@ -74,6 +74,76 @@ def get_setup(setup_id):
     return _create_setup_from_xml(result_dict)
 
 
+def setup_list(flow=None, tag=None, offset=None, size=None):
+    """List all setups matching all of the given filters.
+
+        Perform API call `/setup/list/{filters}
+
+        Parameters
+        ----------
+        flow : int, optional
+
+        tag : str, optional
+
+        offset : int, optional
+
+        size : int, optional
+
+        Returns
+        -------
+        list
+            List of found setups.
+        """
+
+    api_call = "setup/list"
+    if offset is not None:
+        api_call += "/offset/%d" % int(offset)
+    if size is not None:
+        api_call += "/limit/%d" % int(size)
+    if flow is not None:
+        api_call += "/flow/%s" % flow
+    if tag is not None:
+        api_call += "/tag/%s" % tag
+
+    return _list_setups(api_call)
+
+
+def _list_setups(api_call):
+    """Helper function to parse API calls which are lists of setups"""
+
+    xml_string = openml._api_calls._perform_api_call(api_call)
+
+    setups_dict = xmltodict.parse(xml_string)
+    # Minimalistic check if the XML is useful
+    if 'oml:setups' not in setups_dict:
+        raise ValueError('Error in return XML, does not contain "oml:setups": %s'
+                         % str(setups_dict))
+    elif '@xmlns:oml' not in setups_dict['oml:setups']:
+        raise ValueError('Error in return XML, does not contain '
+                         '"oml:runs"/@xmlns:oml: %s'
+                         % str(setups_dict))
+    elif setups_dict['oml:setups']['@xmlns:oml'] != 'http://openml.org/openml':
+        raise ValueError('Error in return XML, value of  '
+                         '"oml:runs"/@xmlns:oml is not '
+                         '"http://openml.org/openml": %s'
+                         % str(setups_dict))
+
+    if isinstance(setups_dict['oml:setups']['oml:setup'], list):
+        setups_list = setups_dict['oml:setups']['oml:setup']
+    elif isinstance(setups_dict['oml:setups']['oml:setup'], dict):
+        setups_list = [setups_dict['oml:setups']['oml:setup']]
+    else:
+        raise TypeError()
+
+    setups = dict()
+    for setup_ in setups_list:
+        # making it a dict to give it the right format
+        current = _create_setup_from_xml({'oml:setup_parameters': setup_})
+        setups[current.setup_id] = current
+
+    return setups
+
+
 def initialize_model(setup_id):
     '''
     Initialized a model based on a setup_id (i.e., using the exact
@@ -147,6 +217,7 @@ def _create_setup_from_xml(result_dict):
     '''
      Turns an API xml result into a OpenMLSetup object
     '''
+    setup_id = int(result_dict['oml:setup_parameters']['oml:setup_id'])
     flow_id = int(result_dict['oml:setup_parameters']['oml:flow_id'])
     parameters = {}
     if 'oml:parameter' not in result_dict['oml:setup_parameters']:
@@ -164,7 +235,7 @@ def _create_setup_from_xml(result_dict):
         else:
             raise ValueError('Expected None, list or dict, received someting else: %s' %str(type(xml_parameters)))
 
-    return OpenMLSetup(flow_id, parameters)
+    return OpenMLSetup(setup_id, flow_id, parameters)
 
 def _create_setup_parameter_from_xml(result_dict):
     return OpenMLParameter(int(result_dict['oml:id']),
@@ -173,4 +244,4 @@ def _create_setup_parameter_from_xml(result_dict):
                            result_dict['oml:parameter_name'],
                            result_dict['oml:data_type'],
                            result_dict['oml:default_value'],
-                           result_dict['oml:value'])
+                           result_dict['oml:value'])

openml/setups/setup.py

@@ -4,13 +4,24 @@ class OpenMLSetup(object):
 
        Parameters
        ----------
+       setup_id : int
+            The OpenML setup id
        flow_id : int
             The flow that it is build upon
         parameters : dict
             The setting of the parameters
            """
 
-    def __init__(self, flow_id, parameters):
+    def __init__(self, setup_id, flow_id, parameters):
+        if not isinstance(setup_id, int):
+            raise ValueError('setup id should be int')
+        if not isinstance(flow_id, int):
+            raise ValueError('flow id should be int')
+        if parameters is not None:
+            if not isinstance(parameters, dict):
+                raise ValueError('parameters should be dict')
+
+        self.setup_id = setup_id
         self.flow_id = flow_id
         self.parameters = parameters
 

tests/test_setups/test_setup_functions.py

@@ -117,3 +117,16 @@ def test_get_setup(self):
                 self.assertIsNone(current.parameters)
             else:
                 self.assertEquals(len(current.parameters), num_params[idx])
+
+
+    def test_setup_list_filter_flow(self):
+        # TODO: please remove for better test
+        # openml.config.server = self.production_server
+
+        flow_id = 31 # TODO please change
+
+        setups = openml.setups.setup_list(flow=31)
+
+        self.assertGreater(len(setups), 0) # TODO: please adjust 0
+        for setup_id in setups.keys():
+            self.assertEquals(setups[setup_id].flow_id, flow_id)