fastdeploy::vision::facedet::YOLOv5Face Class Reference

YOLOv5Face model object used when to load a YOLOv5Face model exported by YOLOv5Face. More...

#include <yolov5face.h>

Inheritance diagram for fastdeploy::vision::facedet::YOLOv5Face:

Collaboration diagram for fastdeploy::vision::facedet::YOLOv5Face:

Public Member Functions
	YOLOv5Face (const std::string &model_file, const std::string &params_file="", const RuntimeOption &custom_option=RuntimeOption(), const ModelFormat &model_format=ModelFormat::ONNX)
	Set path of model file and the configuration of runtime. More...
std::string	ModelName () const
	Get model's name.
virtual bool	Predict (cv::Mat *im, FaceDetectionResult *result, float conf_threshold=0.25, float nms_iou_threshold=0.5)
	Predict the face detection result for an input image. More...
Public Member Functions inherited from fastdeploy::FastDeployModel
virtual bool	Infer (std::vector< FDTensor > &input_tensors, std::vector< FDTensor > *output_tensors)
	Inference the model by the runtime. This interface is included in the Predict() function, so we don't call Infer() directly in most common situation.
virtual bool	Infer ()
	Inference the model by the runtime. This interface is using class member reused_input_tensors_ to do inference and writing results to reused_output_tensors_.
virtual int	NumInputsOfRuntime ()
	Get number of inputs for this model.
virtual int	NumOutputsOfRuntime ()
	Get number of outputs for this model.
virtual TensorInfo	InputInfoOfRuntime (int index)
	Get input information for this model.
virtual TensorInfo	OutputInfoOfRuntime (int index)
	Get output information for this model.
virtual bool	Initialized () const
	Check if the model is initialized successfully.
virtual void	EnableRecordTimeOfRuntime ()
	This is a debug interface, used to record the time of runtime (backend + h2d + d2h) More...
virtual void	DisableRecordTimeOfRuntime ()
	Disable to record the time of runtime, see EnableRecordTimeOfRuntime() for more detail.
virtual std::map< std::string, float >	PrintStatisInfoOfRuntime ()
	Print the statistic information of runtime in the console, see function EnableRecordTimeOfRuntime() for more detail.
virtual bool	EnabledRecordTimeOfRuntime ()
	Check if the EnableRecordTimeOfRuntime() method is enabled.
virtual double	GetProfileTime ()
	Get profile time of Runtime after the profile process is done.
virtual void	ReleaseReusedBuffer ()
	Release reused input/output buffers.

Public Attributes
std::vector< int >	size
	Argument for image preprocessing step, tuple of (width, height), decide the target size after resize, default size = {640, 640}.
int	landmarks_per_face
	Argument for image postprocessing step, setup the number of landmarks for per face (if have), default 5 in official yolov5face note that, the outupt tensor's shape must be: (1,n,4+1+2*landmarks_per_face+1=box+obj+landmarks+cls), default 5.
Public Attributes inherited from fastdeploy::FastDeployModel
std::vector< Backend >	valid_cpu_backends = {Backend::ORT}
	Model's valid cpu backends. This member defined all the cpu backends have successfully tested for the model.
std::vector< Backend >	valid_gpu_backends = {Backend::ORT}
std::vector< Backend >	valid_ipu_backends = {}
std::vector< Backend >	valid_timvx_backends = {}
std::vector< Backend >	valid_directml_backends = {}
std::vector< Backend >	valid_ascend_backends = {}
std::vector< Backend >	valid_kunlunxin_backends = {}
std::vector< Backend >	valid_rknpu_backends = {}
std::vector< Backend >	valid_sophgonpu_backends = {}

Detailed Description

YOLOv5Face model object used when to load a YOLOv5Face model exported by YOLOv5Face.

Constructor & Destructor Documentation

YOLOv5Face()

fastdeploy::vision::facedet::YOLOv5Face::YOLOv5Face	(	const std::string &	model_file,
		const std::string &	params_file = "",
		const RuntimeOption &	custom_option = RuntimeOption(),
		const ModelFormat &	model_format = ModelFormat::ONNX
	)

Set path of model file and the configuration of runtime.

Parameters

[in]	model_file	Path of model file, e.g ./yolov5face.onnx
[in]	params_file	Path of parameter file, e.g ppyoloe/model.pdiparams, if the model format is ONNX, this parameter will be ignored
[in]	custom_option	RuntimeOption for inference, the default will use cpu, and choose the backend defined in "valid_cpu_backends"
[in]	model_format	Model format of the loaded model, default is ONNX format

Member Function Documentation

Predict()

bool fastdeploy::vision::facedet::YOLOv5Face::Predict ( cv::Mat *  im, FaceDetectionResult *  result, float  conf_threshold = 0.25, float  nms_iou_threshold = 0.5  )

virtual

Predict the face detection result for an input image.

Parameters

[in]	im	The input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format
[in]	result	The output face detection result will be writen to this structure
[in]	conf_threshold	confidence threashold for postprocessing, default is 0.25
[in]	nms_iou_threshold	iou threashold for NMS, default is 0.5

Returns

true if the prediction successed, otherwise false

---

The documentation for this class was generated from the following files:

• /fastdeploy/my_work/FastDeploy/fastdeploy/vision/facedet/contrib/yolov5face.h
• /fastdeploy/my_work/FastDeploy/fastdeploy/vision/facedet/contrib/yolov5face.cc