Metadata-Version: 2.1
Name: fdet
Version: 0.2.0
Summary: An easy to use face detection module based on MTCNN and RetinaFace algorithms.
Home-page: http://github.com/acnazarejr/fdet
Author: Antonio C. Nazare Jr.
Author-email: antonio.nazare@dcc.ufmg.br
Maintainer: Antonio C. Nazare Jr.
Maintainer-email: antonio.nazare@dcc.ufmg.br
License: UNKNOWN
Download-URL: http://github.com/acnazarejr/fdet
Description: # FDet - Deep Learning Face Detection
        
        ![Build](https://github.com/acnazarejr/fdet/workflows/Build/badge.svg)
        [![CodeFactor](https://www.codefactor.io/repository/github/acnazarejr/fdet/badge)](https://www.codefactor.io/repository/github/acnazarejr/fdet)
        [![codecov](https://codecov.io/gh/acnazarejr/fdet/branch/master/graph/badge.svg)](https://codecov.io/gh/acnazarejr/fdet)
        ![PyPI](https://img.shields.io/pypi/v/fdet)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fdet)
        ![GitHub release (latest by date)](https://img.shields.io/github/v/release/acnazarejr/fdet)
        [![GitHub](https://img.shields.io/github/license/acnazarejr/fdet)](https://github.com/acnazarejr/fdet/blob/master/LICENSE)
        
        The `fdet` is a ready-to-use implementation of deep learning face detectors using PyTorch.
        
        ![Example](https://github.com/acnazarejr/fdet/raw/master/assets/example.jpg)
        
        ## Features
        
        Currently, there are two different detectors available on FDet:
        
        - **MTCNN** - Joint face detection and alignment using multitask cascaded convolutional networks [[zhang:2016]](#references)
        - **RetinaFace** - Single-stage dense face localisation in the wild. [[deng:2019]](#references)
        
        Despite the availability of different implementations of these algorithms, there are some disadvantages we found when using them. So we create this project to offer the following features, in one package:
        
        - Real-time face detection;
        - Support for batch detection (useful for fast detection of multiple images and videos);
        - Ease of use through python library or command-line app;
        - Provide a unified interface to assign 'CPU' or 'GPU' devices;
        - Multiple GPU's support;
        - On-demand and automatic model weights download;
        - Compatible with Windows, Linux, and macOS systems.
        
        ## Installation
        
        1. You need to [install PyTorch](https://pytorch.org/get-started/locally/) first (if you have a GPU, install PyTorch with CUDA support).
        
        2. Then `fdet` can be installed through pip:
        
        ```bash
        pip install fdet
        ```
        
        ## Quick Start
        
        You can use it in two ways:
        
        ### Python Library
        
        ```python
        >> from fdet import io, RetinaFace
        
        >> image = io.read_as_rgb('example.jpg')
        >> #or: image = cv2.imread('example.jpg', cv2.IMREAD_COLOR)
        >> #    image = cv2.cvtColor(image, cv2.COLOR_BGR2RGB)
        >> detector = RetinaFace(backbone='MOBILENET')
        >> detector.detect(image)
        [{'box': [511, 47, 35, 45],
          'confidence': 0.9999996423721313,
          'keypoints': {'left_eye': [517, 70],
                        'mouth_left': [522, 87],
                        'mouth_right': [531, 83],
                        'nose': [520, 77],
                        'right_eye': [530, 65]}}]
        ```
        
        ### Command-line
        
        ![Example](https://github.com/acnazarejr/fdet/raw/master/assets/terminal.gif)
        
        ## Credits
        
        The FDet was written heavily inspired by the other available implementations ([see credits](#credits)).
        
        - [TropComplique/mtcnn-pytorch](https://github.com/TropComplique/mtcnn-pytorch/)
        - [biubug6/Pytorch_Retinaface](https://github.com/biubug6/Pytorch_Retinaface)
        - [ipazc/mtcnn](https://github.com/ipazc/mtcnn)
        
        The current MTCNN version was implemented with the help of [Davi Beltrão](@Davibeltrao).
        
        ## References
        
        - **[zhang:2016]**: Zhang, K., Zhang, Z., Li, Z. and Qiao, Y. (2016). *Joint face detection and alignment using multitask cascaded convolutional networks*. IEEE Signal Processing Letters, 23(10), 1499-1503. [(link to paper)](https://ieeexplore.ieee.org/abstract/document/7553523)
        
        - **[deng:2019]**: Deng, J., Guo, J., Zhou, Y., Yu, J., Kotsia, I. and Zafeiriou, S. (2019). *Retinaface: Single-stage dense face localisation in the wild*. arXiv preprint arXiv:1905.00641. [(link to paper)](https://arxiv.org/abs/1905.00641)
        
        ## License
        
        [MIT license](https://github.com/acnazarejr/fdet/blob/master/LICENSE)
        
Keywords: face recognition detection biometry
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 7
Classifier: Operating System :: Microsoft :: Windows :: Windows 8
Classifier: Operating System :: Microsoft :: Windows :: Windows 8.1
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.5
Description-Content-Type: text/markdown
