From e887108973a90d77bfbf67f693eec900f01871de Mon Sep 17 00:00:00 2001 From: Wang Ning Date: Tue, 2 Nov 2021 12:23:31 +0000 Subject: [PATCH] Docs/Review human face recognition readme --- examples/human_face_recognition/README.md | 25 +++++++++++++------- examples/human_face_recognition/README_CN.md | 23 +++++++++++------- 2 files changed, 30 insertions(+), 18 deletions(-) diff --git a/examples/human_face_recognition/README.md b/examples/human_face_recognition/README.md index 4c9007e..8644726 100644 --- a/examples/human_face_recognition/README.md +++ b/examples/human_face_recognition/README.md @@ -1,18 +1,25 @@ -# Human Face Recognition Example [[中文]](./README_ZH.md) +# Human Face Recognition [[中文]](./README_CN.md) -The following is the special configuration of face recognition examples. For general configuration, please refer to [this](../../README.md) +This example demonstrates how to recognize human faces captured by the camera of an Espressif development board in real time. The output results of this example can be shown on an LCD screen or in your terminal. -## Configure the face recognition model +## Run the Example -Enter `idf.py menuconfig` in the terminal and click (Top) -> Component config -> ESP-WHO Configuration -> Model Configuration -> Face Recognition to enter the face recognition model configuration interface, as shown below: +Follow steps in [ESP-WHO README](../../README.md) to run the example with default setting. + +## Configure Face Recognition Model + +In addition to default setting, this example allows you to configure model version and quantization type. + +Before Step 4: Flash and Monitor in [ESP-WHO README](../../README.md), run `idf.py menuconfig` in your terminal, go to the face recognition model configuration interface as shown below by entering (Top) -> Component config -> ESP-WHO Configuration -> Model Configuration -> Face Recognition, and configure model version and quantization type: ![](../../img/face_recognition_model_config.png) -You can configure the version and quantification type of the model here. -## How to Use Example -- The interactive button is the Boot button. -- Short press the button: recognize the face captured by the camera at this time. -- Long press the button: enroll the face captured by the camera at this time. +## Use the Example + +You can use the Boot button on the development board for interaction. + +- Short press the button: recognize the face captured by the camera in real time. +- Long press the button: enroll the face captured by the camera in real time. - Double click the button: delete the last enrolled face. diff --git a/examples/human_face_recognition/README_CN.md b/examples/human_face_recognition/README_CN.md index 6f47a1c..f781504 100644 --- a/examples/human_face_recognition/README_CN.md +++ b/examples/human_face_recognition/README_CN.md @@ -1,18 +1,23 @@ -# Human Face Recognition Example [[English]](./README.md) +# 人脸识别 [[English]](./README.md) -以下为使用人脸识别示例的特殊配置，若要进行通用配置可参考此[说明](../../README_ZH.md)。 +本示例展示了如何在乐鑫开发板上识别开发板摄像头实时拍到的人脸。该示例的输出结果可显示在 LCD 屏或终端中。 + +## 运行示例 + +参考 [ESP-WHO README](../../README_CN.md) 中的步骤，以默认配置运行示例。 ## 人脸识别模型配置 -在终端输入 `idf.py menuconfig` ，依次 (Top) -> Component config -> ESP-WHO Configuration -> Model Configuration -> Face Recognition 可进入人脸识别模型配置界面，如下图所示： +若不想使用默认配置，您也可自行配置模型版本和量化方式。 +进行 [ESP-WHO README](../../README_CN.md) 中的步骤 4：运行和监视之前，在终端输入 `idf.py menuconfig` ，依次点击 (Top) -> Component config -> ESP-WHO Configuration -> Model Configuration -> Face Recognition 进入下图所示的人脸识别模型配置界面，配置模型版本和量化方式： ![](../../img/face_recognition_model_config.png) -您可以在这里配置模型的版本和量化方式。 -## 如何使用示例 +## 使用示例 -- 交互按键为Boot键。 -- 短按按键：识别此时摄像头拍到的人脸。 -- 长按按键：录入此时摄像头拍到的人脸。 -- 双击按键：删除最后一个被录入的人脸。 +您可使用开发板上的 Boot 键交互。 + +- 短按 Boot 键：识别摄像头实时拍到的人脸。 +- 长按 Boot 键：录入摄像头实时拍到的人脸。 +- 双击 Boot 键：删除最后一个录入的人脸。