diff --git a/docs/docs_en/api/vision_results/ace_recognition_result.md b/docs/docs_en/api/vision_results/ace_recognition_result.md new file mode 100644 index 000000000..2f7b2b553 --- /dev/null +++ b/docs/docs_en/api/vision_results/ace_recognition_result.md @@ -0,0 +1,25 @@ +# Face Recognition Results + +The FaceRecognitionResult function is defined in `csrcs/fastdeploy/vision/common/result.h` , indicating the embedding of image features by the face recognition model. + +## C++ Definition + +`fastdeploy::vision::FaceRecognitionResult` + +```c++ +struct FaceRecognitionResult { + std::vector embedding; + void Clear(); + std::string Str(); +}; +``` + +- **embedding**: Member variable that indicates the final abstracted feature embedding by the face recognition model, which can be used to calculate the feature similarity between faces. +- **Clear()**: Member function that clears the results stored in a struct. +- **Str()**: Member function that outputs the information in the struct as a string (for Debug). + +## Python Definition + +`fastdeploy.vision.FaceRecognitionResult` + +- **embedding**(list of float): Member variable that indicates the final abstracted feature embedding by the face recognition model, which can be used to calculate the feature similarity between faces.