Initial commit

.gitignore

@@ -0,0 +1,326 @@
+.idea
+*__pycache__*
+*.pyc
+dist
+*egg
+*.egg-info
+*.ipynb_checkpoints/*
+.ipynb_checkpoints
+.DS_Store
+/data/blood-cells.zip
+/data/data
+/dataset
+/dataset-master
+/dataset2-master
+/weights
+mlruns
+*.zip
+*.tar
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,pycharm,jupyternotebooks
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm,jupyternotebooks
+
+### JupyterNotebooks ###
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+*/.ipynb_checkpoints/*
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Remove previous ipynb_checkpoints
+#   git rm -r .ipynb_checkpoints/
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# End of https://www.toptal.com/developers/gitignore/api/python,pycharm,jupyternotebooks
+
+
+node_modules
+/.bazelrc.user
+/.tf_configure.bazelrc
+/bazel-*
+/bazel_pip
+/tools/python_bin_path.sh
+/tensorflow/tools/git/gen
+/pip_test
+/_python_build
+__pycache__
+*.swp
+.vscode/
+cmake_build/
+tensorflow/contrib/cmake/_build/
+.idea/**
+/build/
+[Bb]uild/
+/tensorflow/core/util/version_info.cc
+/tensorflow/python/framework/fast_tensor_util.cpp
+/tensorflow/lite/gen/**
+/tensorflow/lite/tools/make/downloads/**
+/tensorflow/lite/tools/make/gen/**
+/api_init_files_list.txt
+/estimator_api_init_files_list.txt
+*.whl
+
+# Android
+.gradle
+*.iml
+local.properties
+gradleBuild
+
+# iOS
+*.pbxproj
+*.xcworkspace
+/*.podspec
+/tensorflow/lite/**/coreml/**/BUILD
+/tensorflow/lite/**/ios/BUILD
+/tensorflow/lite/**/objc/BUILD
+/tensorflow/lite/**/swift/BUILD
+/tensorflow/lite/examples/ios/simple/data/*.tflite
+/tensorflow/lite/examples/ios/simple/data/*.txt
+Podfile.lock
+Pods
+xcuserdata

README.md

@@ -0,0 +1,70 @@
+# Face-Detection-flask-gunicorn-nginx
+
+This is a simple demonstration of dockerized face-detection API which is implemented with flask and nginx and scaled
+with gunicorn.
+
+# Notes
+
+1. For face-detection, I used pytorch version of mtcnn from deep_utils library. For more information check
+   out [deep_utils](https://github.com/pooya-mohammadi/deep_utils).
+2. The service is scaled up using gunicorn. The gunicorn is a simple library with high throughput for scaling python services.
+    1. To increase the number workers, increase number of `workers` in the `docker-compose.yml` file.
+    2. For more information about gunicorn workers and threads check the following stackoverflow question
+    3. [gunicorn-workers-and-threads](https://stackoverflow.com/questions/38425620/gunicorn-workers-and-threads)
+3. nginx is used as a reverse proxy
+
+# Setup
+
+1. The face-detection name in docker-compose can be changed to any of the models available by deep-utils library.
+2. For simplicity, I placed the weights of the mtcnn-torch model in app/weights.
+3. To use different face-detection models in deep_utils, apply the following changes:
+    1. Change the value of `FACE_DETECTION_MODEL` in the `docker-compose.yml` file.
+    2. Modify configs of a new model in `app/base_app.py` file.
+    3. It's recommended to run the new model in your local system and acquire the downloaded weights from `~/.deep_utils`
+       directory and place it inside `app/weights` directory. This will save you tons of time while working with models with
+       heavy weights.
+    4. If your new model is based on `tensorflow`, comment the `pytorch` installation section in `app/Dockerfile` and
+       uncomment the `tensorflow` installation lines.
+
+# ScaleUp
+
+I scaled the project using gunicorn
+
+# RUN
+
+To run the API, install `docker` and `docker-compose`, execute the following command:
+
+## windows
+
+`docker-compose up --build`
+
+## Linux
+
+`sudo docker-compose up --build`
+
+# Inference
+
+To send an image and get back the boxes run the following commands:
+`curl --request POST ip:port/endpoint -F image=@img-add`
+
+If you run the service on your local system the following request shall work perfectly:
+
+```terminal
+curl --request POST http://127.0.0.1:8080/face -F image=@./sample-images/movie-stars.jpg
+```
+
+# Issues
+
+If you find something missing, please open an issue or kindly create a pull request.  
+
+# References
+
+1.https://github.com/pooya-mohammadi/deep_utils
+
+# Licence
+
+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.