Merge pull request #7 from robmarkcole/development

Adds tests

Author: robmarkcole

README.md

@@ -2,4 +2,9 @@
 [![PyPI Version](https://img.shields.io/pypi/v/deepstack-python.svg)](https://pypi.org/project/deepstack-python/)
 
 # deepstack-python
-Unofficial python API for DeepStack
+Unofficial python API for DeepStack. Provides class for making requests to the object detection endpoint, and functions for processing the result. See the `usage.ipynb` notebook for usage.
+
+## Development
+* Use `venv`
+* `pip install -r requirements-dev.txt`
+* Run tests with `venv/bin/pytest tests/*`

deepstack/core.py

@@ -7,8 +7,6 @@
 
 ## Const
 HTTP_OK = 200
-HTTP_BAD_REQUEST = 400
-HTTP_UNAUTHORIZED = 401
 DEFAULT_TIMEOUT = 10  # seconds
 
 
@@ -26,12 +24,12 @@ def get_confidences_above_threshold(
     return [val for val in confidences if val >= confidence_threshold]
 
 
-def get_object_labels(predictions: List[Dict]) -> Set[str]:
+def get_object_labels(predictions: List[Dict]) -> List[str]:
     """
     Get a list of the unique object labels predicted.
     """
     labels = [pred["label"] for pred in predictions]
-    return set(labels)
+    return list(set(labels))
 
 
 def get_label_confidences(predictions: List[Dict], target_label: str):

requirements-dev.txt

@@ -0,0 +1,3 @@
+pytest
+black
+requests_mock

requirements.txt

@@ -0,0 +1,2 @@
+requests
+pillow

tests/test_deepstack.py

@@ -1 +1,95 @@
-# Placeholder
+# Placeholder
+
+import deepstack.core as ds
+import requests
+import requests_mock
+import pytest
+
+MOCK_IP_ADDRESS = "localhost"
+MOCK_PORT = 5000
+MOCK_URL = "http://{}:{}/v1/vision/detection".format(MOCK_IP_ADDRESS, MOCK_PORT)
+
+MOCK_BYTES = b"Test"
+MOCK_API_KEY = "mock_api_key"
+MOCK_TIMEOUT = 8
+
+MOCK_RESPONSE = {
+    "success": True,
+    "predictions": [
+        {
+            "confidence": 0.6998661,
+            "label": "person",
+            "y_min": 0,
+            "x_min": 258,
+            "y_max": 676,
+            "x_max": 485,
+        },
+        {
+            "confidence": 0.7996547,
+            "label": "person",
+            "y_min": 0,
+            "x_min": 405,
+            "y_max": 652,
+            "x_max": 639,
+        },
+        {
+            "confidence": 0.59745613,
+            "label": "dog",
+            "y_min": 311,
+            "x_min": 624,
+            "y_max": 591,
+            "x_max": 825,
+        },
+    ],
+}
+
+MOCK_PREDICTIONS = MOCK_RESPONSE["predictions"]
+MOCK_CONFIDENCES = [0.6998661, 0.7996547]
+CONFIDENCE_THRESHOLD = 0.7
+
+
+def test_DeepstackObject_process_image_bytes():
+    """Test a good response from server."""
+    with requests_mock.Mocker() as mock_req:
+        mock_req.post(MOCK_URL, status_code=ds.HTTP_OK, json=MOCK_RESPONSE)
+
+        dsobject = ds.DeepstackObject(MOCK_IP_ADDRESS, MOCK_PORT)
+        dsobject.process_image_bytes(MOCK_BYTES)
+        assert dsobject.predictions == MOCK_PREDICTIONS
+
+
+def test_DeepstackObject_process_image_bytes_timeout():
+    """Test a timeout. THIS SHOULD FAIL"""
+    with pytest.raises(ds.DeepstackException) as excinfo:
+        with requests_mock.Mocker() as mock_req:
+            mock_req.post(MOCK_URL, exc=requests.exceptions.ConnectTimeout)
+            dsobject = ds.DeepstackObject(MOCK_IP_ADDRESS, MOCK_PORT)
+            dsobject.process_image_bytes(MOCK_BYTES)
+            assert False
+            assert "SHOULD FAIL" in str(excinfo.value)
+
+
+def test_get_object_labels():
+    """Cant always be sure order of returned list items."""
+    object_labels = ds.get_object_labels(MOCK_PREDICTIONS)
+    assert type(object_labels) is list
+    assert "dog" in object_labels
+    assert "person" in object_labels
+    assert len(object_labels) == 2
+
+
+def test_get_objects_summary():
+    objects_summary = ds.get_objects_summary(MOCK_PREDICTIONS)
+    assert objects_summary == {"dog": 1, "person": 2}
+
+
+def test_get_label_confidences():
+    label_confidences = ds.get_label_confidences(MOCK_PREDICTIONS, "person")
+    assert label_confidences == MOCK_CONFIDENCES
+
+
+def test_get_confidences_above_threshold():
+    assert (
+        len(ds.get_confidences_above_threshold(MOCK_CONFIDENCES, CONFIDENCE_THRESHOLD))
+        == 1
+    )

usage.ipynb

@@ -4,7 +4,21 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This package provides convenience classes and functions for working with deepstack object detection API"
+    "This package provides convenience classes and functions for working with deepstack object detection API. \n",
+    "Pull the latest image for noavx:\n",
+    "```\n",
+    "docker pull deepquestai/deepstack:noavx\n",
+    "```\n",
+    "\n",
+    "Run deepstack with:\n",
+    "```\n",
+    "docker run -e VISION-DETECTION=True -e VISION-FACE=True -e MODE=High -d \\\n",
+    "      -v localstorage:/datastore -p 5000:5000 \\\n",
+    "      -e API-KEY=\"Mysecretkey\" \\\n",
+    "       --name deepstack deepquestai/deepstack:noavx\n",
+    "```\n",
+    "\n",
+    "Note that by default, the minimum confidence for detected objects is 0.45"
    ]
   },
   {
@@ -22,20 +36,19 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
     "IP_ADDRESS = 'localhost'\n",
     "PORT = '5000'\n",
     "API_KEY = \"Mysecretkey\"\n",
-    "# API_KEY = \"BadKey\"\n",
     "TIMEOUT = 8"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -44,7 +57,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [
     {
@@ -75,7 +88,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -104,7 +117,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [
     {
@@ -130,7 +143,7 @@
        "  'x_max': 825}]"
       ]
      },
-     "execution_count": 10,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -149,7 +162,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -165,16 +178,16 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "{'dog', 'person'}"
+       "['person', 'dog']"
       ]
      },
-     "execution_count": 12,
+     "execution_count": 8,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -187,12 +200,12 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Get a summary of the number of occurances of labels, and confidence level"
+    "Get a summary of the number of occurances of labels"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
@@ -201,13 +214,34 @@
        "{'person': 2, 'dog': 1}"
       ]
      },
-     "execution_count": 13,
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "summary = ds.get_objects_summary(dsobject.predictions)\n",
+    "summary"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['person', 'dog']"
+      ]
+     },
+     "execution_count": 10,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "ds.get_objects_summary(dsobject.predictions)"
+    "list(summary.keys())"
    ]
   },
   {
@@ -219,7 +253,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 11,
    "metadata": {},
    "outputs": [
     {
@@ -228,7 +262,7 @@
        "[0.9998661, 0.9996547]"
       ]
      },
-     "execution_count": 14,
+     "execution_count": 11,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -247,17 +281,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "1\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "CONFIDENCE_THRESHOLD = 0.9997\n",
     "print(len(ds.get_confidences_above_threshold(confidences, CONFIDENCE_THRESHOLD)))"