Skip to content

Realtime face detection and recognition using deep learning

License

Notifications You must be signed in to change notification settings

isala404/speculo

Repository files navigation

speculo - Surveillance done smart

CodeFactor CI/CD Pipeline

Speculo is an open source platform that utilizes a Deep Convolution Inverse Graphics Network for indexing faces found in a video footage, specifically for CCTV surveillance. It allows you to browse through these footages by the faces found in them rather than thousands of frames. The key differentiator between regular face recognition software and Speculo is that Speculo can recognize faces in different angles.

Prerequisites

  • React
  • Python 3.8
  • Docker
  • NodeJS
  • OpenCV
  • MongoDB

Development Setup

Clone the Project

git clone https://github.com/mrsupiri/speculo/tree/master

Add the database configuration

Speculo uses MongoDB as the database therefore create a file called database_config.env in the root folder and add the following environment variables;

- DB_NAME
- DB_USERNAME
- DB_PASSWORD
- DB_HOST

Run it

Use --build only when you run it for the first time or if you have made changes to the code

docker-compose up --build

How to contribute?

If you want to contribute to Speculo, be sure to review the guidelines in CONTRIBUTING.md.

Resources

Here are the links to pages that explain the system in detail.

License

MIT