add tag pushing for tasks

Author: amueller

openml/_api_calls.py

@@ -139,7 +139,8 @@ def _parse_server_exception(response):
     additional = None
     if 'oml:additional_information' in server_exception['oml:error']:
         additional = server_exception['oml:error']['oml:additional_information']
-    if code in [370, 372, 512, 500]:
+    if code in [370, 372, 512, 500, 482]:
         # 512 for runs, 370 for datasets (should be 372), 500 for flows
+        # 482 for tasks
         return OpenMLServerNoResult(code, message, additional)
     return OpenMLServerException(code, message, additional)

openml/tasks/functions.py

@@ -7,7 +7,7 @@
 from oslo_concurrency import lockutils
 import xmltodict
 
-from ..exceptions import OpenMLCacheException
+from ..exceptions import OpenMLCacheException, OpenMLServerNoResult
 from ..datasets import get_dataset
 from .task import OpenMLTask, _create_task_cache_dir
 from .. import config
@@ -55,9 +55,9 @@ def _get_estimation_procedure_list():
     Returns
     -------
     procedures : list
-        A list of all estimation procedures. Every procedure is represented by a
-        dictionary containing the following information: id,
-        task type id, name, type, repeats, folds, stratified.
+        A list of all estimation procedures. Every procedure is represented by
+        a dictionary containing the following information: id, task type id,
+        name, type, repeats, folds, stratified.
     """
 
     xml_string = _perform_api_call("estimationprocedure/list")
@@ -138,7 +138,10 @@ def list_tasks(task_type_id=None, offset=None, size=None, tag=None):
 
 
 def _list_tasks(api_call):
-    xml_string = _perform_api_call(api_call)
+    try:
+        xml_string = _perform_api_call(api_call)
+    except OpenMLServerNoResult:
+        return []
     tasks_dict = xmltodict.parse(xml_string, force_list=('oml:task',))
     # Minimalistic check if the XML is useful
     if 'oml:tasks' not in tasks_dict:

openml/tasks/task.py

@@ -4,7 +4,7 @@
 from .. import config
 from .. import datasets
 from .split import OpenMLSplit
-from .._api_calls import _read_url
+from .._api_calls import _read_url, _perform_api_call
 
 
 class OpenMLTask(object):
@@ -96,6 +96,28 @@ def get_split_dimensions(self):
 
         return self.split.repeats, self.split.folds, self.split.samples
 
+    def push_tag(self, tag):
+        """Annotates this flow with a tag on the server.
+
+        Parameters
+        ----------
+        tag : str
+            Tag to attach to the flow.
+        """
+        data = {'flow_id': self.flow_id, 'tag': tag}
+        _perform_api_call("/flow/tag", data=data)
+
+    def remove_tag(self, tag):
+        """Removes a tag from this flow on the server.
+
+        Parameters
+        ----------
+        tag : str
+            Tag to attach to the flow.
+        """
+        data = {'flow_id': self.flow_id, 'tag': tag}
+        _perform_api_call("/flow/untag", data=data)
+
 
 def _create_task_cache_dir(task_id):
     task_cache_dir = os.path.join(config.get_cache_directory(), "tasks", str(task_id))

tests/test_tasks/test_task.py

@@ -1,11 +1,11 @@
 import sys
-import types
 
 if sys.version_info[0] >= 3:
     from unittest import mock
 else:
     import mock
 
+from time import time
 import numpy as np
 
 import openml
@@ -45,6 +45,19 @@ def test_get_X_and_Y(self):
         self.assertIsInstance(Y, np.ndarray)
         self.assertEqual(Y.dtype, float)
 
+    def test_tagging(self):
+        task = openml.tasks.get_task(1)
+        tag = "testing_tag_{}_{}".format(self.id(), time())
+        task_list = openml.tasks.list_tasks(tag=tag)
+        self.assertEqual(len(task_list), 0)
+        task.push_tag(tag)
+        task_list = openml.tasks.list_tasks(tag=tag)
+        self.assertEqual(len(task_list), 1)
+        self.assertIn(1, task_list)
+        task.remove_tag(tag)
+        task_list = openml.tasks.list_tasks(tag=tag)
+        self.assertEqual(len(task_list), 0)
+
     def test_get_train_and_test_split_indices(self):
         openml.config.set_cache_directory(self.static_cache_dir)
         task = openml.tasks.get_task(1882)
@@ -62,4 +75,3 @@ def test_get_train_and_test_split_indices(self):
                                 task.get_train_test_split_indices, 10, 0)
         self.assertRaisesRegexp(ValueError, "Repeat 10 not known",
                                 task.get_train_test_split_indices, 0, 10)
-