README.md · CV_Lab/FaceLabeling

<p align="center">
<a href="https://gitee.com/CV_Lab/face-labeling">
<img src="https://pycver.gitee.io/ows-pics/imgs/facelabeling_logo.png" alt="Simple Icons" >
</a>
<p align="center">
    基于YOLOv5的智能人脸数据标注工具，实现人脸数据标注自动化
</p>
<p align="center">
    可自定义人脸检测模型、可导出多种格式标签，包括PASCAL VOC XML、MS COCO JSON、YOLO TXT
</p>
</p>
<p align="center">
<a href="./CodeCheck.md"><img src="https://img.shields.io/badge/CodeCheck-passing-success" alt="code check" /></a>
<a href="https://gitee.com/CV_Lab/face-labeling/releases/v0.2.2"><img src="https://img.shields.io/badge/Releases-v0.2.2-green" alt="Releases Version" /></a>
<a href="https://github.com/ultralytics/yolov5"><img src="https://img.shields.io/badge/YOLOv5-v7.0-blue" alt="YOLOv5 Version" /></a>
<a href="http://host.robots.ox.ac.uk/pascal/VOC/"><img src="https://img.shields.io/badge/PASCAL%20VOC-XML-blue" alt="PASCAL VOC XML" /></a>
<a href="https://cocodataset.org/"><img src="https://img.shields.io/badge/MS%20COCO-JSON-brightgreen" alt="MS COCO JSON" /></a>
<a href="https://pjreddie.com/darknet/"><img src="https://img.shields.io/badge/YOLO-TXT-orange" alt="YOLO TXT" /></a>
<a href="https://gitee.com/CV_Lab/face-labeling/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-GPL--3.0-blue" alt="License" /></a>
</p>
<p align="center">
<a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/checks-pre--commit-brightgreen" alt="pre-commit"></a>
<a href="#"><img src="https://img.shields.io/badge/Python-3.8%2B-blue?logo=python" alt="Python Version" /></a>
<a href='https://gitee.com/CV_Lab/face-labeling/stargazers'><img src='https://gitee.com/CV_Lab/face-labeling/badge/star.svg?theme=dark' alt='star'></img></a>
<a href='https://gitee.com/CV_Lab/face-labeling/members'><img src='https://gitee.com/CV_Lab/face-labeling/badge/fork.svg?theme=dark' alt='fork'></img></a>
</p>

## 🚀 作者简介

曾逸夫，从事人工智能研究与开发；主研领域：计算机视觉；[YOLOv8官方开源项目代码贡献人](https://github.com/ultralytics/ultralytics/graphs/contributors)；[YOLOv5官方开源项目代码贡献人](https://github.com/ultralytics/yolov5/graphs/contributors)；[YOLOv5 v6.1代码贡献人](https://github.com/ultralytics/yolov5/releases/tag/v6.1)；[YOLOv5 v6.2代码贡献人](https://github.com/ultralytics/yolov5/releases/tag/v6.2)；[YOLOv5 v7.0代码贡献人](https://github.com/ultralytics/yolov5/releases/tag/v7.0)；[Gradio官方开源项目代码贡献人](https://github.com/gradio-app/gradio/graphs/contributors)

❤️  Github：https://github.com/Zengyf-CVer

🔥 YOLOv8 官方开源项目PR ID：

- Fix YOLOv8 Chinese introduction：https://github.com/ultralytics/ultralytics/pull/219
- Add codespell and upgrade some components：https://github.com/ultralytics/ultralytics/pull/599
- Add pycln：https://github.com/ultralytics/ultralytics/pull/7141
- Fix heatmap width and height parameter bug：https://github.com/ultralytics/ultralytics/pull/7368
- ultralytics 8.0.237 cv2.CAP_PROP fix and in_counts and out_counts displays：https://github.com/ultralytics/ultralytics/pull/7380

💡 Ultralytics v8.1.0 代码贡献链接：

- https://github.com/ultralytics/ultralytics/releases/tag/v8.1.0

🔥 YOLOv5 官方开源项目PR ID：

- Save \*.npy features on detect.py `--visualize`：https://github.com/ultralytics/yolov5/pull/5701
- Fix `detect.py --view-img` for non-ASCII paths：https://github.com/ultralytics/yolov5/pull/7093
- Fix Flask REST API：https://github.com/ultralytics/yolov5/pull/7210
- Add yesqa to precommit checks：https://github.com/ultralytics/yolov5/pull/7511
- Add mdformat to precommit checks and update other version：https://github.com/ultralytics/yolov5/pull/7529
- Add TensorRT dependencies：https://github.com/ultralytics/yolov5/pull/8553
- Add paddle tips：https://github.com/ultralytics/yolov5/pull/9502

💡 YOLOv5 v6.1 & v6.2 & v7.0 代码贡献链接：

- https://github.com/ultralytics/yolov5/releases/tag/v6.1
- https://github.com/ultralytics/yolov5/releases/tag/v6.2
- https://github.com/ultralytics/yolov5/releases/tag/v7.0

🔥 Gradio 官方开源项目PR ID：

- Create a color generator demo：https://github.com/gradio-app/gradio/pull/1872

🔥 Gradio 官方开源项目PR ID：

- Create a color generator demo：https://github.com/gradio-app/gradio/pull/1872

- `2022-07-20` **⚡ [Face Labeling v0.2.2 发行版](https://gitee.com/CV_Lab/face-labeling/releases/v0.2.2)正式上线**
- `2022-06-12` **⚡ [Face Labeling v0.2 发行版](https://gitee.com/CV_Lab/face-labeling/releases/v0.2)正式上线**
- `2022-04-25` **⚡ [Face Labeling v0.1 发行版](https://gitee.com/CV_Lab/face-labeling/releases/v0.1)正式上线**

<h2 align="center">💎项目流程与用途</h2>

### 📌 项目整体流程与扩展应用

### 📌 项目功能结构与信息流

```
.
├── face-labeling							# 项目名称
│   ├── util								# 工具包
│   │   ├── voc_xml.py						# PASCAL VOC XML
│   │   ├── coco_json.py					# MS COCO JSON
│   │   ├── yolo_txt.py						# YOLO TXT
│   │   ├── model_opt.py					# 模型管理
│   │   ├── obj_opt.py						# 目标管理
│   │   ├── path_opt.py						# 路径管理
│   │   ├── log.py							# 日志管理
│   │   └── time_format.py					# 日期格式化
│   ├── data								# 测试数据
│   │   └── imgs							# 测试图片，来源于WIDER FACE Test
│   ├── models								# 模型Hub
│   │   ├── readme.md						# 模型Hub README
│   │   ├── *.pt							# PyTorch模型
│   │   └── *.onnx							# ONNX模型
│   ├── face_labeling.py					# 主运行文件
│   ├── LICENSE								# 项目许可
│   ├── CodeCheck.md						# 代码检查
│   ├── .gitignore							# git忽略文件
│   ├── yolov5_widerface.md					# 基于YOLOv5的人脸检测模型的构建
│   ├── yolov5_pytorch_gpu.md				# YOLOv5 PyTorch GPU安装教程
│   ├── README.md							# 项目说明
│   └── requirements.txt					# 脚本依赖包
```

### ✅ 第一步：安装Face Labeling

📌 创建conda环境

```shell
conda create -n facelabel python==3.8
conda activate facelabel # 进入环境
```

📌 克隆

```shell
git clone https://gitee.com/CV_Lab/face-labeling.git
```

### ✅ 第二步：安装Face Labeling依赖

```shell
cd ./face-labeling
conda activate facelabel # 进入环境
pip install -r requirements.txt -U
```

📌 将人脸模型文件（.pt）放入`models` 目录中

❗ 注意：yolov5默认采用pip安装PyTorch GPU版，如果采用官网安装**PyTorch GPU**版，参见[YOLOv5 PyTorch GPU安装教程](./yolov5_pytorch_gpu.md)

### ✅ 基于YOLOv5的人脸检测模型的构建

📌 **widerface-m人脸检测模型**是在[WIDER FACE](http://shuoyang1213.me/WIDERFACE/)数据集上，基于[YOLOv5 v6.1](https://github.com/ultralytics/yolov5)训练的，具体训练过程参见[yolov5_widerface.md](./yolov5_widerface.md)

📌 **darkface-m人脸检测模型**是在[DARK FACE](https://flyywh.github.io/CVPRW2019LowLight/)数据集上，基于[YOLOv5 v6.1](https://github.com/ultralytics/yolov5)训练的，具体训练过程参见[yolov5_darkface.md](./yolov5_darkface.md)

❤️ 本项目提供了以下人脸检测模型：

|    模型名称     |                               下载地址                                |  模型大小  |   适用范围   | 适用设备 |
| :---------: | :---------------------------------------------------------------: | :----: | :------: | :--: |
| widerface-m | [百度云](https://pan.baidu.com/s/19cIqLc05EbyxxEVMX7Lr3g) , 提取码：5gfs | 42.1MB | 实时,图片,视频 | GPU  |
| darkface-m  | [百度云](https://pan.baidu.com/s/1B_Di3eleWZjHFAt3xXd9Og) , 提取码：mm2k | 42.2MB | 实时,图片,视频 | GPU  |

### 💡 webcam实时标注

```shell
# a键捕获视频帧，q键退出
python face_labeling.py
```

### 💡 图片标注（包括批量图片标注）

```shell
python face_labeling.py -m img # 默认测试图片目录data/imgs
python face_labeling.py -m img -imd ./img_dir # 指定图片目录
```

❗ 注：本项目支持的图片输入格式：**jpg** |  **jpeg** | **png** | **bmp** | **tif** | **webp**

### 💡 视频标注（包括批量视频标注）

```shell
python face_labeling.py -m video # 默认测试视频目录data/videos
python face_labeling.py -m video -vd ./video_dir # 指定视频目录
```

❗ 注：本项目支持的视频输入格式：**mp4** | **avi** | **wmv** | **mkv** | **mov** | **gif** | **vob** | **swf** | **mpg** | **flv** | **3gp** | **3g2**

❗ 说明：以上三种检测模式都会在项目根目录中生成`FaceFrame`目录，该目录会生成`frame*`的子目录，子目录结构如下：

```
# webcam和图片标注的目录
.
├── FaceFrame						# 人脸数据保存目录
│   ├── frame						# 子目录
│   │   ├── raw						# 原始图片
│   │   ├── tag						# 标记图片（包括：人脸检测框、人脸ID、置信度、帧ID、FPS、人脸总数，人脸尺寸类型（小、中、大）数量）
│   │   ├── voc_xml					# PASCAL VOC XML 标注文件
│   │   ├── coco_json				# MS COCO JSON 标注文件
│   │   ├── yolo_txt				# YOLO TXT 标注文件
│   ├── frame2						# 子目录
│   │   ├── raw						# 原始图片
│   │   ├── ......
```

```
# 视频标注的目录
.
├── FaceFrame						# 人脸数据保存目录
│   ├── frame						# 子目录
│	│   ├── video_name01			# 子视频目录
│   │   │   ├── raw					# 原始图片
│   │   │   ├── tag					# 标记图片（包括：人脸检测框、人脸ID、置信度、帧ID、FPS、人脸总数，人脸尺寸类型（小、中、大）数量）
│   │   │   ├── voc_xml				# PASCAL VOC XML 标注文件
│   │   │   ├── coco_json			# MS COCO JSON 标注文件
│   │   │   ├── yolo_txt			# YOLO TXT 标注文件
│	│   ├── video_name02			# 子视频目录
│   │   │   ├── raw					# 原始图片
│   │   │   ├── ......
```

❗ 查看检测结果：人脸图片检测结果会保存在`FaceFrame/frame*/tag`中，以`python face_labeling.py -m img`为例运行项目自带检测图片，检测结果如下：

<div align="center" >
widerface-m检测结果
</div>

### 💡 自定义人脸模型

```shell
# 默认为widerface-m
python face_labeling.py -mn face_model # 以实时标注为例
python face_labeling.py -mn darkface-m # 以实时标注为例，darkface-m.pt
```

### 💡 自定义类别

```shell
# 默认为face，以口罩识别为例
python face_labeling.py -cls mask # 口罩类
python face_labeling.py -cls without-mask # 未戴口罩类
```

### 💡 自定义模型参数

```shell
# 可以根据自定义人脸模型进行相应的调参，以实时标注为例

# 自定义设备，默认为cuda:0
python face_labeling.py
python face_labeling.py -dev 0 # cuda:0版
python face_labeling.py -dev cpu # cpu版

# NMS 置信度阈值，默认为0.5
python face_labeling.py -conf 0.8

# NMS IoU阈值，默认为0.45
python face_labeling.py -iou 0.5

# 单张图片的最大检测目标数，默认为1000
python face_labeling.py -mdn 10

# 以上参数也可以同时使用，例如：
python face_labeling.py -conf 0.8 -iou 0.5
python face_labeling.py -conf 0.8 -iou 0.5 -mdn 10

# 模型推理尺寸
python face_labeling.py -isz 320

# 强制重载YOLOv5
python face_labeling.py -ry
```

### 💡 设置标签样式

```shell
# 以实时标注为例
python face_labeling.py -ls id # 标签仅显示ID
python face_labeling.py -ls conf # 标签仅显示置信度（%）
```

<div align="center" >
<img src="https://pycver.gitee.io/ows-pics/imgs/facelabeling_detid.jpg ">
</div>
<div align="center" >
widerface-m检测结果（标签ID）
</div>

<div align="center" >
<img src="https://pycver.gitee.io/ows-pics/imgs/facelabeling_detconf.jpg ">
</div>
<div align="center" >
widerface-m检测结果（标签置信度）
</div>

### 💡 设置标签进度条

```shell
python face_labeling.py -lpb bar
```

<div align="center" >
<img src="https://pycver.gitee.io/ows-pics/imgs/facelabeling_detpbar.jpg ">
</div>
<div align="center" >
widerface-m检测结果（标签进度条）
</div>

### 💡 关闭检测标签

```shell
python face_labeling.py -lds # 以实时标注为例
```

<div align="center" >
<img src="https://pycver.gitee.io/ows-pics/imgs/widerface_m_label_dnt_show.jpg ">
</div>
<div align="center" >
widerface-m检测结果
</div>

### 💡 自定义保存目录名称

```shell
# 默认为FaceFrame
python face_labeling.py -fsd face_dir # 以实时标注为例
```

### 💡 自定义保存子目录名称

```shell
# 默认为frame
python face_labeling.py -fdn face_subDir # 以实时标注为例
```

### 💡 自定义图片前缀

```shell
# 默认为face_test
python face_labeling.py -in face # 以实时标注为例
```

### 💬 技术交流

- 如果你发现任何Face Labeling存在的问题或者是建议, 欢迎通过[Gitee Issues](https://gitee.com/CV_Lab/face-labeling/issues)给我提issues。
- 欢迎加入CV Lab技术交流群

CV_Lab/FaceLabeling

简介

发行版 (3)

贡献者

近期动态

CV_Lab/FaceLabeling .gitee-modal { width: 500px !important; }

简介

发行版 (3)

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

CV_Lab/FaceLabeling