README.md

Gluon FR Toolkit

GluonFR is a toolkit based on MXnet-Gluon, provides SOTA deep learning algorithm and models in face recognition.

此项目灵感来自GluonCV，并按照其结构组织. 除了帮助研究者和开发者们迅速上手目前最前沿的人脸识别算法, 也希望能够让更多的人了解Gluon这一好用的工具, 使用MXnet-Gluon进行深度学习算法的研究.

Installation

GluonFR supports Python 3.5 or later. To install this package you need install GluonCV and MXNet first:

pip install gluoncv --pre
pip install mxnet-mkl --pre --upgrade
# if cuda XX is installed
pip install mxnet-cuXXmkl --pre --upgrade

Then install gluonfr:

git clone https://github.com/THUFutureLab/gluon-face
cd gluon-face/
python3 setup.py install

GluonFR Introduction:

GluonFR is based on MXnet-Gluon, if you are new to it, please check out dmlc 60-minute crash course.

Data:

这一部分主要提供训练和验证数据的输入. GluonFR目前使用的训练集是由DeepInsight提供, 使用mtcnn进行关键点检测并对齐至(112, 112)大小, 详情参考[insightface/Dataset-Zoo]. 另外, data/中还包括nvidia-dali库的使用样例, 在CPU预处理数据成为训练瓶颈时可以考虑试用, 目前dali库中坑还比较多.

使用时将数据按如下结构准备:

face/
    emore/
        train.rec
        train.idx
        property
    ms1m/
        train.rec
        train.idx
        property
    lfw.bin
    agedb_30.bin
    ...
    vgg2_fp.bin

We use ~/.mxnet/datasets as default dataset root to match mxnet setting.

Model:

mobile_facenet，res_attention_net，se_resnet等。

Loss:

GluonFR提供了近年来主流人脸识别损失函数的实现，包括SoftmaxCrossEntropyLoss，ArcLoss，TripletLoss，RingLoss，CosLoss，L2Softmax，ASoftmax，CenterLoss，ContrastiveLoss等, 并在今后会持续更新.

Example:

GluonFR提供了Mnist手写数字识别的训练和可视化代码，用于验证损失函数的有效性;在人脸识别数据集上基于model-zoo模型完成训练。

GluonFR中的Loss:

下表中最后一列是论文中在LFW上的最优结果，数据、网络结构都可能不同，仅供参考。

Pretrained Models

To be continued.

Todo

• More pretrained models
• IJB and Megaface Results
• Other losses
• Dataloader for loss depend on how to provide batches like Triplet, ContrastiveLoss, RangeLoss...
• Try GluonCV resnetV1b/c/d/ to improve performance
• Create hosted docs
• Test module
• Pypi package

Docs

GluonFR documentation is not available now.

Authors

{ haoxintong Yangxv Haoyadong Sunhao }

Discussion

中文社区Gluon-Forum Feel free to use English here :D.

References

1. MXNet Documentation and Tutorials https://zh.diveintodeeplearning.org/

2. NVIDIA DALI documentationNVIDIA DALI documentation

3. Deepinsight insightface