Clean code. Particularly, change title in GUI.

docker/dockerfile → docker/Dockerfile

@@ -1,13 +1,18 @@
-FROM python:3.6
+# Use Python 3 base image
+FROM python:3
 
+# Add maintainer information
 LABEL maintainer="[email protected]"
 
-COPY docker/requirements.txt .
-
+# Add project
 COPY src/main /main
 
+# Install requirements
+COPY docker/requirements.txt .
 RUN pip install -r requirements.txt
 
+# Set work dir
 WORKDIR /main
 
-CMD ["uvicorn", "start:app", "--host", "0.0.0.0", "--port", "7770"]
+# Set init command
+CMD ["uvicorn", "start:app", "--host", "0.0.0.0", "--port", "7770"]

install_prerequisites.sh

@@ -1,26 +1,28 @@
 #!/bin/bash
 
-# This will install docker following [https://docs.docker.com/install/linux/docker-ce/ubuntu/]
+# Install Docker as described in https://docs.docker.com/install/linux/docker-ce/ubuntu/
+# Prepare environment
 sudo apt-get remove docker docker-engine docker.io
 sudo apt-get update
 
+# Add further dependencies
 sudo apt-get install \
     apt-transport-https \
     ca-certificates \
     curl \
     software-properties-common
 
+# Add Docker package repository
 curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
 sudo apt-key fingerprint 0EBFCD88
-
 sudo add-apt-repository \
    "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
    $(lsb_release -cs) \
    stable"
 
+# Install Docker and add user
 sudo apt-get update
 sudo apt-get install -y docker-ce 
 sudo groupadd docker
 sudo usermod -aG docker ${USER}
-docker run hello-world
-
+docker run hello-world

src/main/deep_learning_service.py

@@ -1,3 +1,4 @@
+# Import dependencies
 import os
 import json
 import uuid
@@ -6,9 +7,8 @@
 from inference.exceptions import ModelNotFound, InvalidModelConfiguration, ModelNotLoaded, InferenceEngineNotFound, \
     InvalidInputData, ApplicationError
 
-
+# Deep learning service class
 class DeepLearningService:
-
     def __init__(self):
         """
         Sets the models base directory, and initializes some dictionaries.
@@ -164,4 +164,4 @@ def get_config(self, model_name):
         """
         if not self.model_loaded(model_name):
             self.load_model(model_name)
-        return self.models_dict[model_name].configuration
+        return self.models_dict[model_name].configuration

src/main/inference/base_error.py

@@ -1,10 +1,10 @@
+# Import dependencies
 import logging
 from datetime import datetime
 from abc import ABC, abstractmethod
 
-
+# Abstract error class
 class AbstractError(ABC):
-
     def __init__(self):
         """
         Sets the logger file, level, and format.
@@ -43,4 +43,4 @@ def error(self, message):
         :param message: Containing the request status and the model response
         :return:
         """
-        pass
+        pass

src/main/inference/base_inference_engine.py

@@ -1,9 +1,9 @@
+# Import dependencies
 from abc import ABC, abstractmethod
 from inference.exceptions import InvalidModelConfiguration, ModelNotLoaded, ApplicationError
 
-
+# Abstract inference engine class
 class AbstractInferenceEngine(ABC):
-
     def __init__(self, model_path):
         """
         Takes a model path and calls the load function.
@@ -89,4 +89,4 @@ def validate_json_configuration(self, data):
         pass
 
     def __del__(self):
-        self.free()
+        self.free()

src/main/inference/errors.py

@@ -1,11 +1,11 @@
+# Import dependencies
 import os
 import logging
 from datetime import datetime, date
 from inference.base_error import AbstractError
 
-
+# Abstract error class
 class Error(AbstractError):
-
     def __init__(self):
         if 'logs' not in os.listdir():
             os.mkdir('logs')
@@ -44,4 +44,4 @@ def check_date(self):
         b = datetime.strptime(oldest_date, '%Y-%m-%d')
         delta = a - b
         if delta.days > 365:
-            os.remove('logs/' + oldest_log_file)
+            os.remove('logs/' + oldest_log_file)

src/main/inference/exceptions.py

@@ -1,9 +1,9 @@
+# Define meta class
 __metaclass__ = type
 
 
 class ApplicationError(Exception):
     """Base class for other exceptions"""
-
     def __init__(self, default_message, additional_message=''):
         self.default_message = default_message
         self.additional_message = additional_message
@@ -18,39 +18,34 @@ def get_message(self):
 
 class InvalidModelConfiguration(ApplicationError):
     """Raised when the model's configuration is corrupted"""
-
     def __init__(self, additional_message=''):
         # super('Invalid model configuration', additional_message)
         super().__init__('Invalid model configuration', additional_message)
 
 
 class ModelNotFound(ApplicationError):
     """Raised when the model is not found"""
-
     def __init__(self, additional_message=''):
         # super('Model not found', additional_message)
         super().__init__('Model not found', additional_message)
 
 
 class ModelNotLoaded(ApplicationError):
     """Raised when the model is not loaded"""
-
     def __init__(self, additional_message=''):
         # super('Error loading model', additional_message)
         super().__init__('Error loading model', additional_message)
 
 
 class InvalidInputData(ApplicationError):
     """Raised when the input data is corrupted"""
-
     def __init__(self, additional_message=''):
         # super('Invalid input data', additional_message)
         super().__init__('Invalid input data', additional_message)
 
 
 class InferenceEngineNotFound(ApplicationError):
     """Raised when the Inference Engine is not found"""
-
     def __init__(self, additional_message=''):
         # super('Inference engine not found', additional_message)
-        super().__init__('Inference engine not found', additional_message)
+        super().__init__('Inference engine not found', additional_message)

src/main/inference/inference_engines_factory.py

@@ -1,10 +1,10 @@
+# Import dependencies
 import os
 import json
 from inference.exceptions import ModelNotFound, ApplicationError, InvalidModelConfiguration, InferenceEngineNotFound, ModelNotLoaded
 
-
+# Inference engine factory class
 class InferenceEngineFactory:
-
     @staticmethod
     def get_engine(path_to_model):
         """

src/main/inference/yolov3_opencv_cpu_detection.py

@@ -1,3 +1,4 @@
+# Import dependencies
 import os
 import cv2
 import uuid
@@ -9,9 +10,8 @@
 from inference.base_inference_engine import AbstractInferenceEngine
 from inference.exceptions import InvalidModelConfiguration, InvalidInputData, ApplicationError
 
-
+# Inference engine class
 class InferenceEngine(AbstractInferenceEngine):
-
     def __init__(self, model_path):
         self.net = None
         self.scale = None
@@ -234,4 +234,4 @@ def validate_json_configuration(self, data):
         try:
             jsonschema.validate(data, schema)
         except Exception as e:
-            raise InvalidModelConfiguration(e)
+            raise InvalidModelConfiguration(e)

src/main/models.py

@@ -1,5 +1,5 @@
+# API response class
 class ApiResponse:
-
     def __init__(self, success=True, data=None, error=None):
         """
         Defines the response shape
@@ -9,4 +9,4 @@ def __init__(self, success=True, data=None, error=None):
         """
         self.data = data
         self.error = error.get_message() if error is not None else ''
-        self.success = success
+        self.success = success

src/main/start.py

@@ -1,3 +1,4 @@
+# Import dependencies
 import sys
 from starlette.responses import FileResponse
 from models import ApiResponse
@@ -10,28 +11,20 @@
 	InferenceEngineNotFound, InvalidInputData
 from inference.errors import Error
 
+# Append path
 sys.path.append('./inference')
 
+# Init deep learning service
 dl_service = DeepLearningService()
 error_logging = Error()
-app = FastAPI(version='3.1.0', title='BMW InnovationLab YOLOv3 opencv inference Automation',
-			  description="<b>API for performing YOLOv3 opencv inference</b></br></br>"
+app = FastAPI(version='3.1.0', title='BMW InnovationLab YOLOv3 OpenCV Inference Automation',
+			  description="<b>API for YOLOv3 OpenCV Inference</b></br></br>"
 						  "<b>Contact the developers:</b></br>"
 						  "<b>Antoine Charbel: <a href='mailto:[email protected]'>[email protected]</a></b></br>"
 						  "<b>BMW Innovation Lab: <a href='mailto:[email protected]'>[email protected]</a></b>")
 
 
-# app.mount("/public", StaticFiles(directory="/main/public"), name="public")
-
-# app.add_middleware(
-#     CORSMiddleware,
-#     allow_origins=["*"],
-#     allow_credentials=True,
-#     allow_methods=["*"],
-#     allow_headers=["*"],
-# )
-
-
+# Load app
 @app.get('/load')
 def load_custom():
 	"""
@@ -189,4 +182,4 @@ async def list_model_config(model_name: str):
 	:return: List of model's configuration
 	"""
 	config = dl_service.get_config(model_name)
-	return ApiResponse(data=config)
+	return ApiResponse(data=config)