Outletter

Technology Stack

This is a list of mostly used technologies and libraries that are used in Outletter project:

• Python: Python is an interpreted high-level programming language for general-purpose programming.

• Django: Django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design.

• Tensorflow: Tensorflow is a ML framework specifically for Neural Network purposes.

• Scikit: Scikit is an ML library for many tasks including performance metrics.

• Open-CV: Open-CV is usually used for image processing purposes.

DevOps

• Docker, Docker Compose

Installation

We use docker to run the project.

Download Docker

Docker can't help for some devices. If the project does not work with Docker, Docker Toolbox will help you.

Download Docker Toolbox

Install Nvidia Container Toolkit for GPU usage for Tensorflow although you wont be able to use gpu with the ./do.sh script.

Download Nvidia Container Toolkit

Download the model weights from the link and create a folder named: "resources" in the Base folder and put the weights in it.

Download Weights

Without GPU

Running django

$ ENV=DEV ./do.sh start

Help will show all possible commands

$ ENV=DEV ./do.sh help

Stopping django /logs

$ ./do.sh stop
$ ./do.sh logs

With GPU (USE WITH CAUTION, REQUIRES MANUAL CODE TRANSFER TO CONTAINER. USE WITHOUT GPU FOR NORMAL USAGE)

Running django

$ ENV=DEV ./do.sh build
$ make start
$ make migrate

Stopping django

$ make stop
$ make prune

Admin user

toni > secret
(localhost:8000/admin/) 

Maintainer

• Mian Usman Naeem Kakakhel [email protected]