1#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3# *******************************************************************************
4#
5# Copyright (c) 2020 Baidu.com, Inc. All Rights Reserved
6#
7# *******************************************************************************
8import numpy as np
9
10ERROR_CODE_FAILED_DECODING_INPUT = 336005
11MESSAGE_FAILED_DECODING_INPUT = "Failed decoding input"
12ERROR_CODE_MISSING_REQUIRED_PARAMETER = 336006
13MESSAGE_MISSING_REQUIRED_PARAMETER = "Missing required parameter"
14
15from xgboost import DMatrix
16
17
18class CustomException(RuntimeError):
19    """
20    进行模型验证和部署服务必需的异常类，缺少该类在代码验证时将会失败
21    在处理异常数据或者请求时，推荐在`PredictWrapper`中的自定义预处理preprocess和后处理postprocess函数中抛出`CustomException`类，
22    并为`message`指定准确可读的错误信息，以便在服务响应包中的`error_msg`参数中返回。
23    """
24    def __init__(self, error_code, message, orig_error=None):
25        """ init with error_code, message and origin exception """
26        super(CustomException, self).__init__(message)
27        self.error_code = error_code
28        self.orig_error = orig_error
29
30
31class PredictWrapper(object):
32    """ 模型服务预测封装类，支持用户自定义对服务请求数据的预处理和模型预测结果的后处理函数 """
33
34    def __init__(self, model_path, use_gpu, logger):
35        """
36        根据`model_path`初始化`PredictWrapper`类，如解析label_list.txt，加载模型输出标签id和标签名称的映射关系
37        :param model_path: 该目录下存放了用户选择的模型版本中包含的所有文件
38        """
39        # 加载模型
40        model_filename = model_path + '/model.pkl'
41        try:
42            with open(model_filename, 'rb') as pk_fin:
43                import pickle
44                self._model = pickle.load(pk_fin)
45        except:
46            import joblib
47            self._model = joblib.load(model_filename)
48        
49        algo = self._model.__class__.__name__
50        self._is_booster = (algo == 'Booster')
51
52    def preprocess(self, request_body):
53        """
54        自定义对请求体的预处理，针对图像类模型服务，包括对图片对图像的解析、转化等
55        :param request_body: 请求体的json字典
56        :return:
57            data: 用于模型预测的输入。
58            infer_args: 用于模型预测的其他参数
59            request_context: 透传给自定义后处理函数`postprocess`的参数，例如指定返回预测结果的top N，过滤低score的阈值threshold.
60        """
61        try:
62            features = request_body['features']
63            features = np.array(features)
64            if self._is_booster:
65                features = DMatrix(features)
66        except KeyError:
67            raise CustomException(error_code=ERROR_CODE_MISSING_REQUIRED_PARAMETER,
68                                  message=MESSAGE_MISSING_REQUIRED_PARAMETER)
69        except Exception as e:
70            raise CustomException(error_code=ERROR_CODE_FAILED_DECODING_INPUT,
71                                  message=MESSAGE_FAILED_DECODING_INPUT, orig_error=e)
72        return features, {}, {}
73
74    def predict(self, data, infer_args):
75        """
76        模型预测
77        :param data: 预处理后的数据
78        :param infer_args: 预处理返回的`infer_args`
79        :return: infer_result 预测结果
80        """
81        return self._model.predict(data, **infer_args)
82
83    def postprocess(self, infer_result, request_context):
84        """
85        对ml模型预测结果进行后处理
86        :param infer_result: ML模型的预测结果
87        :param request_context: 自定义预处理函数中返回的`request context`
88        :return: request results 请求的处理结果
89        """
90        if not isinstance(infer_result, np.ndarray):
91            infer_result = np.array(infer_result)
92        return {'categories': infer_result.tolist()}