Skip to main content

Multitask Cascaded Convolutional Networks for face detection and alignment (MTCNN) in Python >= 3.10 and TensorFlow >= 2.12

Project description

MTCNN - Multitask Cascaded Convolutional Networks for Face Detection and Alignment

PyPI version Documentation Status Test Status Pylint Check PyPI Downloads

Overview

Example

MTCNN is a robust face detection and alignment library implemented for Python >= 3.10 and TensorFlow >= 2.12, designed to detect faces and their landmarks using a multitask cascaded convolutional network. This library improves on the original implementation by offering a complete refactor, simplifying usage, improving performance, and providing support for batch processing.

This library is ideal for applications requiring face detection and alignment, with support for both bounding box and landmark prediction.

Installation

MTCNN can be installed via pip:

pip install mtcnn

MTCNN requires Tensorflow >= 2.12. This external dependency can be installed manually or automatically along with MTCNN via:

pip install mtcnn[tensorflow]

Usage Example

from mtcnn import MTCNN
from mtcnn.utils.images import load_image

# Create a detector instance
detector = MTCNN(device="CPU:0")

# Load an image
image = load_image("ivan.jpg")

# Detect faces in the image
result = detector.detect_faces(image)

# Display the result
print(result)

Output example:

[
    {
        "box": [277, 90, 48, 63],
        "keypoints": {
            "nose": (303, 131),
            "mouth_right": (313, 141),
            "right_eye": (314, 114),
            "left_eye": (291, 117),
            "mouth_left": (296, 143)
        },
        "confidence": 0.9985
    }
]

Models Overview

MTCNN uses a cascade of three networks to detect faces and facial landmarks:

  • PNet (Proposal Network): Scans the image and proposes candidate face regions.
  • RNet (Refine Network): Refines the face proposals from PNet.
  • ONet (Output Network): Detects facial landmarks (eyes, nose, mouth) and provides a final refinement of the bounding boxes.

All networks are implemented using TensorFlow’s functional API and optimized to avoid unnecessary operations, such as transpositions, ensuring faster and more efficient execution.

Documentation

The full documentation for this project is available at Read the Docs.

Citation

If you use this library for your research or projects, please consider citing the original work:

@article{7553523,
    author={K. Zhang and Z. Zhang and Z. Li and Y. Qiao}, 
    journal={IEEE Signal Processing Letters}, 
    title={Joint Face Detection and Alignment Using Multitask Cascaded Convolutional Networks}, 
    year={2016}, 
    volume={23}, 
    number={10}, 
    pages={1499-1503}, 
    keywords={Benchmark testing;Computer architecture;Convolution;Detectors;Face;Face detection;Training;Cascaded convolutional neural network (CNN);face alignment;face detection}, 
    doi={10.1109/LSP.2016.2603342}, 
    ISSN={1070-9908}, 
    month={Oct}
}

You may also reference the original GitHub repository that this project was based on (including the networks weights):
Original MTCNN Implementation by Kaipeng Zhang

And the FaceNet's implementation that served as inspiration: Facenet's MTCNN implementation

About this project

The code for this project was created to standardize face detection and provide an easy-to-use framework that helps the research community push the boundaries of AI knowledge. Learn more about the author of this code on Iván de Paz Centeno's website

If you find this project useful, please consider supporting it through GitHub Sponsors.

Sponsor

Your support will help cover costs related to improving the codebase, adding new features, and providing better documentation.

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mtcnn-1.0.0.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

mtcnn-1.0.0-py3-none-any.whl (1.9 MB view details)

Uploaded Python 3

File details

Details for the file mtcnn-1.0.0.tar.gz.

File metadata

  • Download URL: mtcnn-1.0.0.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for mtcnn-1.0.0.tar.gz
Algorithm Hash digest
SHA256 08428bf8e1ae9827d43a40bb0246b57f2239e3572d3742f472ae9924896c6419
MD5 76b0a158169879c60a32c49f0679bc04
BLAKE2b-256 6737b0f60411b6a37dcd5122bbe05c9aa45f271bcc8129caa45ee1012251905d

See more details on using hashes here.

File details

Details for the file mtcnn-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mtcnn-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for mtcnn-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0a96b4868e56db9ae984449519642be6dba03240e608a67e928ebb47833e9144
MD5 f789c355204fd7dfd315dc39a79fd387
BLAKE2b-256 dc7e0b2b688a9e2d353a661b617b12d00d9af29f877b57c8e4a3cbe447483b46

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page