FaceXLib

English | 简体中文

---

facexlib 的目标是基于当前最先进的开源方法，提供开箱即用的 人脸相关 功能。
目前仅提供 PyTorch 参考代码。如需训练或微调，请参考下方列出的原始仓库。
请注意，我们仅对这些算法进行了整理和集成，具体使用时请务必参考其原始许可证。

如果 facexlib 对您的项目有所帮助，请为本仓库点个赞 :star: 。感谢您 :blush:
其他推荐项目：   :arrow_forward: Real-ESRGAN   :arrow_forward: GFPGAN   :arrow_forward: BasicSR

---

:sparkles: 功能

功能	来源	原始许可证
检测	Pytorch_Retinaface	MIT
对齐	AdaptiveWingLoss	Apache 2.0
识别	InsightFace_Pytorch	MIT
分割	face-parsing.PyTorch	MIT
抠图	MODNet	CC 4.0
头部姿态估计	deep-head-pose	Apache 2.0
跟踪	SORT	GPL 3.0
质量评估	hyperIQA	-
工具	人脸修复助手	-

:eyes: 演示与教程

:wrench: 依赖与安装

• Python >= 3.7（建议使用 Anaconda 或 Miniconda）
• PyTorch >= 1.7
• 可选：NVIDIA GPU + CUDA

安装

pip install facexlib

预训练模型

首次推理时会 自动 下载预训练模型。
如果网络不稳定，您可以提前下载（可使用其他下载工具），并将模型文件放置在 PACKAGE_ROOT_PATH/facexlib/weights 目录下。

:scroll: 许可证与致谢

本项目采用 MIT 许可证发布。

:e-mail: 联系方式

如有任何问题，请提交 Issue 或发送邮件至 xintao.wang@outlook.com。

FaceXLib 快速上手指南

FaceXLib 是一个基于当前最先进（SOTA）开源方法的面部相关功能库，提供开箱即用的检测、对齐、识别、解析、抠图、姿态估计、跟踪及质量评估等功能。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统: Linux / Windows / macOS
• Python: >= 3.7 (推荐使用 Anaconda 或 Miniconda 管理环境)
• 深度学习框架: PyTorch >= 1.7
• 硬件加速 (可选): NVIDIA GPU + CUDA (推荐安装以显著提升推理速度)

安装步骤

1. 安装依赖

建议使用国内镜像源加速安装过程。

pip install facexlib -i https://pypi.tuna.tsinghua.edu.cn/simple

如果需要手动安装 PyTorch（未安装情况下），请访问 PyTorch 官网 获取适合您环境的命令，或使用清华源：

pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118

(注：cu118 仅为示例，请根据实际 CUDA 版本调整)

2. 预训练模型说明

首次运行推理代码时，库会自动下载所需的预训练模型。

• 网络不稳定用户：可提前手动下载模型文件，并放置于 PACKAGE_ROOT_PATH/facexlib/weights 目录下。
• 模型下载地址通常可在各功能模块的 README 或 GitHub Releases 页面找到。

基本使用

以下是一个最简单的人脸检测示例：

from facexlib.detection import init_detection_model, detect_face

# 1. 初始化检测模型 (自动下载权重)
det_net = init_detection_model('retinaface_resnet50', half=False)

# 2. 准备图像 (假设 img 为 numpy 数组，格式为 HxWxC, RGB)
# img = cv2.imread('test.jpg') 
# img = cv2.cvtColor(img, cv2.COLOR_BGR2RGB)

# 3. 执行检测
bboxes, scores, landmarks = detect_face(img, 0.95, det_net, 'cuda')

# 输出结果
print(f"检测到人脸数量：{len(bboxes)}")
print(f"边界框坐标：{bboxes}")

其他功能模块（如对齐、识别、解析等）的使用方式类似，均需先通过 init_xxx_model 初始化模型，再调用对应的处理函数。具体参数请参考各子模块文档。