mirror of
				https://github.com/PaddlePaddle/FastDeploy.git
				synced 2025-10-31 11:56:44 +08:00 
			
		
		
		
	 cbf88a46fa
			
		
	
	cbf88a46fa
	
	
	
		
			
			* 第一次提交 * 补充一处漏翻译 * deleted: docs/en/quantize.md * Update one translation * Update en version * Update one translation in code * Standardize one writing * Standardize one writing * Update some en version * Fix a grammer problem * Update en version for api/vision result * Merge branch 'develop' of https://github.com/charl-u/FastDeploy into develop * Checkout the link in README in vision_results/ to the en documents * Modify a title * Add link to serving/docs/ * Finish translation of demo.md * Update english version of serving/docs/ * Update title of readme * Update some links * Modify a title * Update some links * Update en version of java android README * Modify some titles * Modify some titles * Modify some titles * modify article to document * update some english version of documents in examples * Add english version of documents in examples/visions * Sync to current branch * Add english version of documents in examples * Add english version of documents in examples * Add english version of documents in examples * Update some documents in examples * Update some documents in examples * Update some documents in examples * Update some documents in examples * Update some documents in examples * Update some documents in examples * Update some documents in examples * Update some documents in examples * Update some documents in examples
		
			
				
	
	
		
			83 lines
		
	
	
		
			4.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			83 lines
		
	
	
		
			4.1 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
| English | [简体中文](README_CN.md)
 | |
| # RetinaFace Python Deployment Example
 | |
| 
 | |
| Before deployment, two steps require confirmation
 | |
| 
 | |
| - 1. Software and hardware should meet the requirements. Please refer to [FastDeploy  Environment Requirements](../../../../../docs/en/build_and_install/download_prebuilt_libraries.md)  
 | |
| - 2. Install FastDeploy Python whl package. Refer to [FastDeploy Python Installation](../../../../../docs/en/build_and_install/download_prebuilt_libraries.md)
 | |
| 
 | |
| This directory provides examples that `infer.py` fast finishes the deployment of RetinaFace on CPU/GPU and GPU accelerated by TensorRT. The script is as follows
 | |
| 
 | |
| ```bash
 | |
| # Download the example code for deployment
 | |
| git clone https://github.com/PaddlePaddle/FastDeploy.git
 | |
| cd examples/vision//retinaface/python/
 | |
| 
 | |
| # Download retinaface model files and test images
 | |
| wget https://bj.bcebos.com/paddlehub/fastdeploy/Pytorch_RetinaFace_mobile0.25-640-640.onnx
 | |
| wget https://raw.githubusercontent.com/DefTruth/lite.ai.toolkit/main/examples/lite/resources/test_lite_face_detector_3.jpg
 | |
| 
 | |
| # CPU inference
 | |
| python infer.py --model Pytorch_RetinaFace_mobile0.25-640-640.onnx --image test_lite_face_detector_3.jpg --device cpu
 | |
| # GPU inference
 | |
| python infer.py --model Pytorch_RetinaFace_mobile0.25-640-640.onnx --image test_lite_face_detector_3.jpg --device gpu
 | |
| # TensorRT inference on GPU 
 | |
| python infer.py --model Pytorch_RetinaFace_mobile0.25-640-640.onnx --image test_lite_face_detector_3.jpg --device gpu --use_trt True
 | |
| ```
 | |
| 
 | |
| The visualized result after running is as follows
 | |
| 
 | |
| <img width="640" src="https://user-images.githubusercontent.com/67993288/184301763-1b950047-c17f-4819-b175-c743b699c3b1.jpg">
 | |
| 
 | |
| ## RetinaFace Python Interface 
 | |
| 
 | |
| ```python
 | |
| fastdeploy.vision.facedet.RetinaFace(model_file, params_file=None, runtime_option=None, model_format=ModelFormat.ONNX)
 | |
| ```
 | |
| 
 | |
| RetinaFace model loading and initialization, among which model_file is the exported ONNX model format
 | |
| 
 | |
| **Parameter**
 | |
| 
 | |
| > * **model_file**(str): Model file path 
 | |
| > * **params_file**(str): Parameter file path. No need to set when the model is in ONNX format
 | |
| > * **runtime_option**(RuntimeOption): Backend inference configuration. None by default, which is the default configuration
 | |
| > * **model_format**(ModelFormat): Model format. ONNX format by default
 | |
| 
 | |
| ### predict function
 | |
| 
 | |
| > ```python
 | |
| > RetinaFace.predict(image_data, conf_threshold=0.25, nms_iou_threshold=0.5)
 | |
| > ```
 | |
| >
 | |
| > Model prediction interface. Input images and output detection results.
 | |
| >
 | |
| > **Parameter**
 | |
| >
 | |
| > > * **image_data**(np.ndarray): Input data in HWC or BGR format
 | |
| > > * **conf_threshold**(float): Filtering threshold of detection box confidence
 | |
| > > * **nms_iou_threshold**(float): iou threshold during NMS processing
 | |
| 
 | |
| > **Return**
 | |
| >
 | |
| > > Return `fastdeploy.vision.FaceDetectionResult` structure. Refer to [Vision Model Prediction Results](../../../../../docs/api/vision_results/) for its description.
 | |
| 
 | |
| ### Class Member Property
 | |
| #### Pre-processing Parameter
 | |
| Users can modify the following pre-processing parameters to their needs, which affects the final inference and deployment results
 | |
| 
 | |
| > > * **size**(list[int]): This parameter changes the size of the resize used during preprocessing, containing two integer elements for [width, height] with default value [640, 640]
 | |
| > > * **variance**(list[float]): Specify the variance value in retinaface. Default [0.1,0.2]. Normally without modification.
 | |
| > > * **min_sizes**(list[list[int]]): Set width and height of anchor in retinaface. Default {{16, 32}, {64, 128}, {256, 512}}, corresponding to the step size 8, 16 and 32
 | |
| > > * **downsample_strides**(list[int]): This parameter is used to change the down-sampling multiple of the feature map that generates anchor, containing three integer elements that represent the default down-sampling multiple for generating anchor. Default value [8, 16, 32]
 | |
| > > * **landmarks_per_face**(int): Specify the number of keypoints in the face detected. Default 5.
 | |
| 
 | |
| 
 | |
| 
 | |
| ## Other Documents
 | |
| 
 | |
| - [RetinaFace Model Description](..)
 | |
| - [RetinaFace C++ Deployment](../cpp)
 | |
| - [Model Prediction Results](../../../../../docs/api/vision_results/)
 | |
| - [How to switch the model inference backend engine](../../../../../docs/en/faq/how_to_change_backend.md)
 |