FastDeploy  latest
Fast & Easy to Deploy!
Public Member Functions | List of all members
fastdeploy::vision::matting::PPMatting Class Reference

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

#include <ppmatting.h>

Inheritance diagram for fastdeploy::vision::matting::PPMatting:
Inheritance graph
[legend]
Collaboration diagram for fastdeploy::vision::matting::PPMatting:
Collaboration graph
[legend]

Public Member Functions

 PPMatting (const std::string &model_file, const std::string &params_file, const std::string &config_file, const RuntimeOption &custom_option=RuntimeOption(), const ModelFormat &model_format=ModelFormat::PADDLE)
 Set path of model file and configuration file, and the configuration of runtime. More...
 
std::string ModelName () const
 Get model's name.
 
virtual bool Predict (cv::Mat *im, MattingResult *result)
 Predict the matting 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.
 

Additional Inherited Members

- Public Attributes inherited from fastdeploy::FastDeployModel
std::vector< Backendvalid_cpu_backends = {Backend::ORT}
 Model's valid cpu backends. This member defined all the cpu backends have successfully tested for the model.
 
std::vector< Backendvalid_gpu_backends = {Backend::ORT}
 
std::vector< Backendvalid_ipu_backends = {}
 
std::vector< Backendvalid_timvx_backends = {}
 
std::vector< Backendvalid_directml_backends = {}
 
std::vector< Backendvalid_ascend_backends = {}
 
std::vector< Backendvalid_kunlunxin_backends = {}
 
std::vector< Backendvalid_rknpu_backends = {}
 
std::vector< Backendvalid_sophgonpu_backends = {}
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PPMatting()

fastdeploy::vision::matting::PPMatting::PPMatting ( const std::string &  model_file,
const std::string &  params_file,
const std::string &  config_file,
const RuntimeOption custom_option = RuntimeOption(),
const ModelFormat model_format = ModelFormat::PADDLE 
)

Set path of model file and configuration file, and the configuration of runtime.

Parameters
[in]model_filePath of model file, e.g PPMatting-512/model.pdmodel
[in]params_filePath of parameter file, e.g PPMatting-512/model.pdiparams, if the model format is ONNX, this parameter will be ignored
[in]config_filePath of configuration file for deployment, e.g PPMatting-512/infer_cfg.yml
[in]custom_optionRuntimeOption for inference, the default will use cpu, and choose the backend defined in valid_cpu_backends
[in]model_formatModel format of the loaded model, default is Paddle format

Member Function Documentation

◆ Predict()

bool fastdeploy::vision::matting::PPMatting::Predict ( cv::Mat *  im,
MattingResult result 
)
virtual

Predict the matting result for an input image.

Parameters
[in]imThe input image data, comes from cv::imread(), is a 3-D array with layout HWC, BGR format
[in]resultThe output matting result will be writen to this structure
Returns
true if the prediction successed, otherwise false

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