mirror of
https://github.com/open-mmlab/mmdeploy.git
synced 2025-01-14 08:09:43 +08:00
d79413fa32
* update c-api's comments by following doxygen's guide * fix according to review comments
75 lines
3.0 KiB
C
75 lines
3.0 KiB
C
// Copyright (c) OpenMMLab. All rights reserved.
|
|
|
|
/**
|
|
* @file classifier.h
|
|
* @brief Interface to MMClassification task
|
|
*/
|
|
|
|
#ifndef MMDEPLOY_CLASSIFIER_H
|
|
#define MMDEPLOY_CLASSIFIER_H
|
|
|
|
#include "common.h"
|
|
|
|
typedef struct mm_class_t {
|
|
int label_id;
|
|
float score;
|
|
} mm_class_t;
|
|
|
|
/**
|
|
* @brief Create classifier's handle
|
|
* @param[in] model an instance of mmclassification sdk model created by
|
|
* \ref mmdeploy_model_create_by_path or \ref mmdeploy_model_create in \ref model.h
|
|
* @param[in] device_name name of device, such as "cpu", "cuda", etc.
|
|
* @param[in] device_id id of device.
|
|
* @param[out] handle instance of a classifier, which must be destroyed
|
|
* by \ref mmdeploy_classifier_destroy
|
|
* @return status of creating classifier's handle
|
|
*/
|
|
MM_SDK_API int mmdeploy_classifier_create(mm_model_t model, const char* device_name, int device_id,
|
|
mm_handle_t* handle);
|
|
|
|
/**
|
|
* @brief Create classifier's handle
|
|
* @param[in] model_path path of mmclassification sdk model exported by mmdeploy model converter
|
|
* @param[in] device_name name of device, such as "cpu", "cuda", etc.
|
|
* @param[in] device_id id of device.
|
|
* @param[out] handle instance of a classifier, which must be destroyed
|
|
* by \ref mmdeploy_classifier_destroy
|
|
* @return status of creating classifier's handle
|
|
*/
|
|
MM_SDK_API int mmdeploy_classifier_create_by_path(const char* model_path, const char* device_name,
|
|
int device_id, mm_handle_t* handle);
|
|
|
|
/**
|
|
* @brief Use classifier created by \ref mmdeploy_classifier_create_by_path to get label
|
|
* information of each image in a batch
|
|
* @param[in] handle classifier's handle created by \ref mmdeploy_classifier_create_by_path
|
|
* @param[in] mats a batch of images
|
|
* @param[in] mat_count number of images in the batch
|
|
* @param[out] results a linear buffer to save classification results of each
|
|
* image, which must be freed by \ref mmdeploy_classifier_release_result
|
|
* @param[out] result_count a linear buffer with length being \p mat_count to save the number of
|
|
* classification results of each image. It must be released by \ref
|
|
* mmdeploy_classifier_release_result
|
|
* @return status of inference
|
|
*/
|
|
MM_SDK_API int mmdeploy_classifier_apply(mm_handle_t handle, const mm_mat_t* mats, int mat_count,
|
|
mm_class_t** results, int** result_count);
|
|
|
|
/**
|
|
* @brief Release the inference result buffer created \ref mmdeploy_classifier_apply
|
|
* @param[in] results classification results buffer
|
|
* @param[in] result_count \p results size buffer
|
|
* @param[in] count length of \p result_count
|
|
*/
|
|
MM_SDK_API void mmdeploy_classifier_release_result(mm_class_t* results, const int* result_count,
|
|
int count);
|
|
|
|
/**
|
|
* @brief Destroy classifier's handle
|
|
* @param[in] handle classifier's handle created by \ref mmdeploy_classifier_create_by_path
|
|
*/
|
|
MM_SDK_API void mmdeploy_classifier_destroy(mm_handle_t handle);
|
|
|
|
#endif // MMDEPLOY_CLASSIFIER_H
|