added model inference

Author: ulsha

cord/client.py

@@ -14,7 +14,7 @@
 # under the License.
 
 """ ``cord.client`` provides a simple Python client that allows you
-to query project resources through the Cord API.
+to query project resources through the Cord REST API.
 
 Here is a simple example for instantiating the client and obtaining project info:
 
@@ -32,11 +32,14 @@
 
 import sys
 import logging
+import json
+import base64
 
 from cord.configs import CordConfig
 from cord.http.querier import Querier
 from cord.orm.project import Project
 from cord.orm.label_blurb import Label
+from cord.orm.model import Model, ModelInferenceParams
 
 # Logging configuration
 logging.basicConfig(stream=sys.stdout,
@@ -146,5 +149,49 @@ def save_label_blurb(self, uid, label):
             CorruptedLabelError: If a blurb is corrupted (e.g. if the frame labels have more frames than the video).
         """
         label = Label(label)
-        return self._querier.basic_setter(Label, uid, label)
+        return self._querier.basic_setter(Label, uid, payload=label)
+
+    def model_inference(self,
+                        uid,
+                        file_path,
+                        conf_thresh=0.6,
+                        iou_thresh=0.3,
+                        device="cuda",
+                        detection_frame_range=None,
+                        ):
+        """
+        Run inference with model trained on the platform.
+
+        Args:
+            uid: A model_iteration_hash (uid) string.
+            file_path: Local file path to image or video
+            conf_thresh: Confidence threshold (default 0.6)
+            iou_thresh: Intersection over union threshold (default 0.3)
+            device: Device (CPU or CUDA, default is CUDA)
+            detection_frame_range: Detection frame range (optional, if video)
+
+        Returns:
+            Inference results: A dict of inference results.
+
+        Raises:
+            AuthenticationError: If the project API key is invalid.
+            AuthorisationError: If access to the specified resource is restricted.
+            ResourceNotFoundError: If no model exists by the specified model_iteration_hash (uid).
+            UnknownError: If an error occurs while running inference.
+            FileTypeNotSupportedError: If the file type is not supported for inference (has to be an image or video)
+            MustSetDetectionRangeError: If a detection range is not set for video inference
+        """
+        if detection_frame_range is None:
+            detection_frame_range = []
+
+        file = open(file_path, 'rb').read()
+
+        params = ModelInferenceParams({
+            'file': base64.b64encode(file).decode('utf-8'),
+            'conf_thresh': conf_thresh,
+            'iou_thresh': iou_thresh,
+            'device': device,
+            'detection_frame_range': detection_frame_range,
+        })
 
+        return self._querier.basic_setter(Model, uid, payload=params)

cord/configs.py

@@ -19,12 +19,12 @@
 from abc import ABCMeta
 import cord.exceptions
 
-CORD_ENDPOINT = 'https://api.cord.tech/public'
+CORD_ENDPOINT = 'http://127.0.0.1:8000/public'
 _CORD_PROJECT_ID = 'CORD_PROJECT_ID'
 _CORD_API_KEY = 'CORD_API_KEY'
 
-READ_TIMEOUT = 15  # In seconds
-WRITE_TIMEOUT = 30  # In seconds
+READ_TIMEOUT = 120  # In seconds
+WRITE_TIMEOUT = 120  # In seconds
 CONNECT_TIMEOUT = 15  # In seconds
 
 log = logging.getLogger(__name__)

cord/exceptions.py

@@ -70,5 +70,21 @@ class AnswerDictionaryError(CordException):
 
 
 class CorruptedLabelError(CordException):
-    """ Exception thrown when a label is corrupted (e.g. the frame labels have more frames than the video. """
+    """ Exception thrown when a label is corrupted (e.g. the frame labels have more frames than the video.) """
+    pass
+
+
+class FileTypeNotSupportedError(CordException):
+    """ Exception thrown when a file type is not supported
+    Supported file types are: image/jpeg, image/png, video/webm, video/mp4. """
+    pass
+
+
+class MustSetDetectionRangeError(CordException):
+    """ Exception thrown when a detection range is not set for video """
+    pass
+
+
+class DetectionRangeInvalidError(CordException):
+    """ Exception thrown when a detection range is invalid (e.g. negative or higher than num frames in video) """
     pass

cord/http/error_utils.py

@@ -8,6 +8,9 @@
 OPERATION_NOT_ALLOWED_ERROR = ['OPERATION_NOT_ALLOWED']
 ANSWER_DICTIONARY_ERROR = ['ANSWER_DICTIONARY_ERROR']
 CORRUPTED_LABEL_ERROR = ['CORRUPTED_LABEL_ERROR']
+FILE_TYPE_NOT_SUPPORTED_ERROR = ['FILE_TYPE_NOT_SUPPORTED_ERROR']
+MUST_SET_DETECTION_RANGE_ERROR = ['MUST_SET_DETECTION_RANGE_ERROR']
+DETECTION_RANGE_INVALID_ERROR = ['DETECTION_RANGE_INVALID_ERROR']
 
 
 def check_error_response(response):
@@ -36,4 +39,14 @@ def check_error_response(response):
         raise CorruptedLabelError("The label blurb is corrupted. This could be due to the number of "
                                   "frame labels exceeding the number of frames in the labelled video.")
 
+    if response == FILE_TYPE_NOT_SUPPORTED_ERROR:
+        raise FileTypeNotSupportedError("Supported file types are: image/jpeg, image/png, video/webm, video/mp4.")
+
+    if response == MUST_SET_DETECTION_RANGE_ERROR:
+        raise MustSetDetectionRangeError("You must set a detection range for video inference")
+
+    if response == DETECTION_RANGE_INVALID_ERROR:
+        raise DetectionRangeInvalidError("The detection range is invalid (e.g. less than 0, or"
+                                         " higher than num frames in the video)")
+
     pass

cord/http/querier.py

@@ -68,7 +68,7 @@ def basic_setter(self, db_object_type, uid, payload):
         res = self.execute(request)
 
         if res:
-            return True
+            return res
         else:
             raise RequestException("Setting %s with uid %s failed." % (db_object_type, uid))
 

cord/orm/model.py

@@ -0,0 +1,52 @@
+#
+# Copyright (c) 2020 Cord Technologies Limited
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from collections import OrderedDict
+
+from cord.orm import base_orm
+
+
+class Model(base_orm.BaseORM):
+    """
+    Model base ORM.
+
+    ORM:
+
+    """
+
+    DB_FIELDS = OrderedDict([])
+
+
+class ModelInferenceParams(base_orm.BaseORM):
+    """
+    Model inference parameters for running models trained via the platform.
+
+    ORM:
+
+    local_file_path,
+    conf_thresh,
+    iou_thresh,
+    device
+    detection_frame_range (optional)
+
+    """
+
+    DB_FIELDS = OrderedDict([
+        ("file", str),
+        ("conf_thresh", float),  # Confidence threshold
+        ("iou_thresh", float),  # Intersection over union threshold
+        ("device", str),
+        ("detection_frame_range", list)
+    ])