KServe Python Serving Runtime API¶
ModelServer
¶
Source code in kserve/model_server.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 |
|
__init__(http_port=args.http_port, grpc_port=args.grpc_port, workers=args.workers, max_threads=args.max_threads, max_asyncio_workers=args.max_asyncio_workers, registered_models=None, enable_grpc=args.enable_grpc, enable_docs_url=args.enable_docs_url, enable_latency_logging=args.enable_latency_logging, access_log_format=args.access_log_format)
¶
KServe ModelServer Constructor
Parameters:
Name | Type | Description | Default |
---|---|---|---|
http_port |
int
|
HTTP port. Default: |
http_port
|
grpc_port |
int
|
GRPC port. Default: |
grpc_port
|
workers |
int
|
Number of uvicorn workers. Default: |
workers
|
max_threads |
int
|
Max number of gRPC processing threads. Default: |
max_threads
|
max_asyncio_workers |
int
|
Max number of AsyncIO threads. Default: |
max_asyncio_workers
|
registered_models |
Optional[ModelRepository]
|
A optional Model repository with registered models. |
None
|
enable_grpc |
bool
|
Whether to turn on grpc server. Default: |
enable_grpc
|
enable_docs_url |
bool
|
Whether to turn on |
enable_docs_url
|
enable_latency_logging |
bool
|
Whether to log latency metric. Default: |
enable_latency_logging
|
access_log_format |
str
|
Format to set for the access log (provided by asgi-logger). Default: |
access_log_format
|
Source code in kserve/model_server.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
|
default_exception_handler(loop, context)
¶
Default exception handler for event loop.
This is called when an exception occurs and no exception handler is set. This can be called by a custom exception handler that wants to defer to the default handler behavior.
Source code in kserve/model_server.py
341 342 343 344 345 346 347 348 349 350 351 352 |
|
register_exception_handler(handler)
¶
Add a custom handler as the event loop exception handler.
If a handler is not provided, the default exception handler will be set.
handler should be a callable object, it should have a signature matching '(loop, context)', where 'loop'
will be a reference to the active event loop, 'context' will be a dict object (see call_exception_handler()
documentation for details about context).
Source code in kserve/model_server.py
327 328 329 330 331 332 333 334 335 336 337 338 339 |
|
register_model(model)
¶
Register a model to the model server.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model |
BaseKServeModel
|
The model object. |
required |
Source code in kserve/model_server.py
354 355 356 357 358 359 360 361 362 363 |
|
start(models)
¶
Start the model server with a set of registered models.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
models |
List[BaseKServeModel]
|
a list of models to register to the model server. |
required |
Source code in kserve/model_server.py
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
|
stop(sig=None)
async
¶
Stop the instances of REST and gRPC model servers.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
sig |
Optional[int]
|
The signal to stop the server. Default: |
None
|
Source code in kserve/model_server.py
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
|
BaseKServeModel
¶
Bases: ABC
A base class to inherit all of the kserve models from.
This class implements the expectations of model repository and model server.
Source code in kserve/model.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
__init__(name)
¶
Adds the required attributes
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the model. |
required |
Source code in kserve/model.py
49 50 51 52 53 54 55 56 57 |
|
healthy()
¶
Check the health of this model. By default returns self.ready
.
Returns:
Type | Description |
---|---|
bool
|
True if healthy, false otherwise |
Source code in kserve/model.py
59 60 61 62 63 64 65 66 |
|
load()
¶
Load handler can be overridden to load the model from storage.
The self.ready
should be set to True after the model is loaded. The flag is used for model health check.
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if model is ready, False otherwise |
Source code in kserve/model.py
68 69 70 71 72 73 74 75 76 |
|
start()
¶
Start handler can be overridden to perform model setup
Source code in kserve/model.py
78 79 80 |
|
stop()
¶
Stop handler can be overridden to perform model teardown
Source code in kserve/model.py
82 83 84 |
|
InferenceModel
¶
Bases: BaseKServeModel
Abstract class representing a model that supports standard inference and prediction.
Source code in kserve/model.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
|
Model
¶
Bases: InferenceModel
Source code in kserve/model.py
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
|
__call__(body, headers=None, verb=InferenceVerb.PREDICT)
async
¶
Method to call predictor or explainer with the given input.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
body |
Union[Dict, CloudEvent, InferRequest]
|
Request body. |
required |
verb |
InferenceVerb
|
The inference verb for predict/generate/explain |
PREDICT
|
headers |
Optional[Dict[str, str]]
|
Request headers. |
None
|
Returns:
Type | Description |
---|---|
InferReturnType
|
Response output from preprocess -> predict/generate/explain -> postprocess |
Source code in kserve/model.py
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
|
__init__(name, predictor_config=None)
¶
KServe Model Public Interface
Model is intended to be subclassed to implement the model handlers.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the model. |
required |
predictor_config |
Optional[PredictorConfig]
|
The configurations for http call to the predictor. |
None
|
Source code in kserve/model.py
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
|
explain(payload, headers=None)
async
¶
explain
handler can be overridden to implement the model explanation.
The default implementation makes call to the explainer if explainer_host
is specified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
payload |
Dict
|
Explainer model inputs passed from preprocess handler. |
required |
headers |
Dict[str, str]
|
Request headers. |
None
|
Returns:
Type | Description |
---|---|
Dict
|
An Explanation for the inference result. |
Source code in kserve/model.py
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
|
load()
¶
Load handler can be overridden to load the model from storage.
The self.ready
should be set to True after the model is loaded. The flag is used for model health check.
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if model is ready, False otherwise |
Source code in kserve/model.py
298 299 300 301 302 303 304 305 306 |
|
postprocess(result, headers=None)
async
¶
The postprocess
handler can be overridden for inference result or response transformation.
The predictor sends back the inference result in Dict
for v1 endpoints and InferResponse
for v2 endpoints.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
result |
Union[Dict, InferResponse]
|
The inference result passed from |
required |
headers |
Dict[str, str]
|
Request headers. |
None
|
Returns:
Type | Description |
---|---|
Union[Dict, InferResponse]
|
A Dict or InferResponse after post-process to return back to the client. |
Source code in kserve/model.py
325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
|
predict(payload, headers=None)
async
¶
The predict
handler can be overridden for performing the inference.
By default, the predict handler makes call to predictor for the inference step.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
payload |
Union[Dict, InferRequest, ModelInferRequest]
|
Model inputs passed from |
required |
headers |
Dict[str, str]
|
Request headers. |
None
|
Returns:
Type | Description |
---|---|
Union[Dict, InferResponse, AsyncIterator[Any]]
|
Inference result or a Response from the predictor. |
Source code in kserve/model.py
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
|
preprocess(payload, headers=None)
async
¶
preprocess
handler can be overridden for data or feature transformation.
The model decodes the request body to Dict
for v1 endpoints and InferRequest
for v2 endpoints.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
payload |
Union[Dict, InferRequest]
|
Payload of the request. |
required |
headers |
Dict[str, str]
|
Request headers. |
None
|
Returns:
Type | Description |
---|---|
Union[Dict, InferRequest]
|
A Dict or InferRequest in KServe Model Transformer mode which is transmitted on the wire to predictor. |
Union[Dict, InferRequest]
|
Tensors in KServe Predictor mode which is passed to predict handler for performing the inference. |
Source code in kserve/model.py
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
|
PredictorConfig
¶
Source code in kserve/model.py
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
|
__init__(predictor_host, predictor_protocol=PredictorProtocol.REST_V1.value, predictor_use_ssl=False, predictor_request_timeout_seconds=600)
¶
The configuration for the http call to the predictor
Parameters:
Name | Type | Description | Default |
---|---|---|---|
predictor_host |
str
|
The host name of the predictor |
required |
predictor_protocol |
str
|
The inference protocol used for predictor http call |
REST_V1.value
|
predictor_use_ssl |
bool
|
Enable using ssl for http connection to the predictor |
False
|
predictor_request_timeout_seconds |
int
|
The request timeout seconds for the predictor http call |
600
|
Source code in kserve/model.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
|
InferInput
¶
Source code in kserve/protocol/infer_type.py
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
|
data: Union[List, np.ndarray, InferTensorContents]
property
writable
¶
Get the data of the inference input associated with this object.
Returns:
Type | Description |
---|---|
Union[List, ndarray, InferTensorContents]
|
The data of the inference input. |
datatype: str
property
¶
Get the datatype of inference input associated with this object.
Returns:
Type | Description |
---|---|
str
|
The datatype of the inference input. |
name: str
property
¶
Get the name of inference input associated with this object.
Returns:
Type | Description |
---|---|
str
|
The name of the inference input |
parameters: Union[Dict, MessageMap[str, InferParameter], None]
property
writable
¶
Get the parameters of the inference input associated with this object.
Returns:
Type | Description |
---|---|
Union[Dict, MessageMap[str, InferParameter], None]
|
The additional inference parameters |
shape: List[int]
property
writable
¶
Get the shape of inference input associated with this object.
Returns:
Type | Description |
---|---|
List[int]
|
The shape of the inference input. |
__init__(name, shape, datatype, data=None, parameters=None)
¶
An object of InferInput class is used to describe the input tensor of an inference request.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the inference input whose data will be described by this object. |
required |
shape |
The shape of the associated inference input. |
required | |
datatype |
The data type of the associated inference input. |
required | |
data |
The data of the inference input.
When data is not set, raw_data is used for gRPC to transmit with numpy array bytes
by using |
None
|
|
parameters |
The additional inference parameters. |
None
|
Source code in kserve/protocol/infer_type.py
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
|
as_numpy()
¶
Decode the inference input data as numpy array.
Returns:
Type | Description |
---|---|
ndarray
|
A numpy array of the inference input data |
Source code in kserve/protocol/infer_type.py
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
|
as_string()
¶
Decodes the inference input data as a list of strings.
Returns:
Type | Description |
---|---|
List[List[str]]
|
List[List[str]]: The decoded data as a list of strings. |
Raises:
Type | Description |
---|---|
InvalidInput
|
If the datatype of the inference input is not 'BYTES'. |
Source code in kserve/protocol/infer_type.py
220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
|
set_data_from_numpy(input_tensor, binary_data=True)
¶
Set the tensor data from the specified numpy array for input associated with this object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_tensor |
The tensor data in numpy array format. |
required | |
binary_data |
Indicates whether to set data for the input in binary format or explicit tensor within JSON. The default value is True, which means the data will be delivered as binary data with gRPC or in the HTTP body after the JSON object for REST. |
True
|
Source code in kserve/protocol/infer_type.py
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
|
InferOutput
¶
Source code in kserve/protocol/infer_type.py
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 |
|
data: Union[List, np.ndarray, InferTensorContents]
property
writable
¶
Get the data of inference output associated with this object.
Returns:
Type | Description |
---|---|
Union[List, ndarray, InferTensorContents]
|
The data of inference output. |
datatype: str
property
¶
Get the data type of inference output associated with this object.
Returns:
Type | Description |
---|---|
str
|
The data type of inference output. |
name: str
property
¶
Get the name of inference output associated with this object.
Returns:
Type | Description |
---|---|
str
|
The name of inference output. |
parameters: Union[Dict, MessageMap[str, InferParameter], None]
property
writable
¶
Get the parameters of inference output associated with this object.
Returns:
Type | Description |
---|---|
Union[Dict, MessageMap[str, InferParameter], None]
|
The additional inference parameters associated with the inference output. |
shape: List[int]
property
writable
¶
Get the shape of inference output associated with this object.
Returns:
Type | Description |
---|---|
List[int]
|
The shape of inference output |
__init__(name, shape, datatype, data=None, parameters=None)
¶
An object of InferOutput class is used to describe the output tensor for an inference response.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
The name of inference output whose data will be described by this object. |
required | |
shape |
The shape of the associated inference output. |
required | |
datatype |
The data type of the associated inference output. |
required | |
data |
The data of the inference output. When data is not set, raw_data is used for gRPC with numpy array bytes by calling set_data_from_numpy. |
None
|
|
parameters |
The additional inference parameters. |
None
|
Source code in kserve/protocol/infer_type.py
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 |
|
as_numpy()
¶
Decode the tensor output data as numpy array.
Returns:
Type | Description |
---|---|
ndarray
|
The numpy array of the associated inference output data. |
Source code in kserve/protocol/infer_type.py
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 |
|
set_data_from_numpy(output_tensor, binary_data=True)
¶
Set the tensor data from the specified numpy array for the inference output associated with this object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_tensor |
The tensor data in numpy array format. |
required | |
binary_data |
Indicates whether to set data for the input in binary format or explicit tensor within JSON. The default value is True, which means the data will be delivered as binary data with gRPC or in the HTTP body after the JSON object for REST. |
True
|
Source code in kserve/protocol/infer_type.py
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 |
|
InferRequest
¶
Source code in kserve/protocol/infer_type.py
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 |
|
use_binary_outputs: bool
property
¶
This attribute is used to determine if all the outputs should be returned as raw binary format. For REST, Get the binary_data_output attribute from the parameters. This will be ovverided by the individual output's 'binary_data' parameter. For GRPC, It is True, if the received inputs are raw_inputs, otherwise False. For GRPC, if the inputs are raw_inputs, then the outputs should be returned as raw_outputs.
Returns:
Type | Description |
---|---|
bool
|
a boolean indicating whether to use binary raw outputs |
__init__(model_name, infer_inputs, request_id=None, raw_inputs=None, from_grpc=False, parameters=None, request_outputs=None)
¶
InferRequest Data Model.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_name |
str
|
The model name. |
required |
infer_inputs |
List[InferInput]
|
The inference inputs for the model. |
required |
request_id |
Optional[str]
|
The id for the inference request. |
None
|
raw_inputs |
The binary data for the inference inputs. |
None
|
|
from_grpc |
Optional[bool]
|
Indicate if the data model is constructed from gRPC request. |
False
|
parameters |
Optional[Union[Dict, MessageMap[str, InferParameter]]]
|
The additional inference parameters. |
None
|
request_outputs |
Optional[List[RequestedOutput]]
|
The output tensors requested for this inference. |
None
|
Source code in kserve/protocol/infer_type.py
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
|
as_dataframe()
¶
Decode the tensor inputs as pandas dataframe.
Returns:
Type | Description |
---|---|
DataFrame
|
The inference input data as pandas dataframe |
Source code in kserve/protocol/infer_type.py
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 |
|
from_bytes(req_bytes, json_length, model_name)
classmethod
¶
The class method to construct the InferRequest object from REST raw request bytes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
req_bytes |
bytes
|
The raw InferRequest in bytes. |
required |
json_length |
int
|
The length of the json bytes. |
required |
model_name |
str
|
The name of the model. |
required |
Returns:
Name | Type | Description |
---|---|---|
InferRequest |
InferRequest
|
The resulting InferRequest object. |
Raises:
Type | Description |
---|---|
InvalidInput
|
If the request format is unrecognized or if necessary fields are missing. |
Source code in kserve/protocol/infer_type.py
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 |
|
from_grpc(request)
classmethod
¶
Class method to construct an InferRequest object from a ModelInferRequest object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request |
ModelInferRequest
|
The gRPC ModelInferRequest object to be converted. |
required |
Returns:
Name | Type | Description |
---|---|---|
InferRequest |
InferRequest
|
The resulting InferRequest object. |
Source code in kserve/protocol/infer_type.py
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
|
from_inference_request(request, model_name)
classmethod
¶
The class method to construct the InferRequest object from InferenceRequest object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
request |
InferenceRequest
|
The InferenceRequest object. |
required |
model_name |
str
|
The name of the model. |
required |
Source code in kserve/protocol/infer_type.py
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 |
|
get_input_by_name(name)
¶
Find an input Tensor in the InferenceRequest that has the given name Args: name : str name of the input Tensor object Returns: InferInput The InferInput with the specified name, or None if no input with this name exists
Source code in kserve/protocol/infer_type.py
860 861 862 863 864 865 866 867 868 869 870 871 872 873 |
|
to_grpc()
¶
Converts the InferRequest object to gRPC ModelInferRequest type.
Returns:
Type | Description |
---|---|
ModelInferRequest
|
ModelInferRequest gRPC type converted from InferRequest object. |
Source code in kserve/protocol/infer_type.py
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 |
|
to_rest()
¶
Converts the InferRequest object to v2 REST InferRequest Dict or bytes. This method is used to convert the InferRequest object into a format that can be sent over a REST API.
Returns:
Type | Description |
---|---|
Tuple[Union[bytes, Dict], Optional[int]]
|
Tuple[Union[bytes, Dict], Optional[int]]: A tuple containing the InferRequest in bytes or Dict and the length of the JSON part of the request. If it is dict, then the json length will be None. |
Raises:
Type | Description |
---|---|
InvalidInput
|
If the data is missing for an input or if both 'data' and 'raw_data' fields are set for an input. |
Source code in kserve/protocol/infer_type.py
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 |
|
InferResponse
¶
Source code in kserve/protocol/infer_type.py
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 |
|
__init__(response_id, model_name, infer_outputs, model_version=None, raw_outputs=None, from_grpc=False, parameters=None, use_binary_outputs=False, requested_outputs=None)
¶
The InferResponse Data Model
Parameters:
Name | Type | Description | Default |
---|---|---|---|
response_id |
str
|
The id of the inference response. |
required |
model_name |
str
|
The name of the model. |
required |
infer_outputs |
List[InferOutput]
|
The inference outputs of the inference response. |
required |
model_version |
Optional[str]
|
The version of the model. |
None
|
raw_outputs |
The raw binary data of the inference outputs. |
None
|
|
from_grpc |
Optional[bool]
|
Indicate if the InferResponse is constructed from a gRPC response. |
False
|
parameters |
Optional[Union[Dict, MessageMap[str, InferParameter]]]
|
The additional inference parameters. |
None
|
use_binary_outputs |
Optional[bool]
|
A boolean indicating whether the data for the outputs should be in binary format when sent over REST API. This will be overridden by the individual output's binary_data attribute. |
False
|
requested_outputs |
Optional[List[RequestedOutput]]
|
The output tensors requested for this inference. |
None
|
Source code in kserve/protocol/infer_type.py
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 |
|
from_bytes(res_bytes, json_length)
classmethod
¶
Class method to construct an InferResponse object from raw response bytes. This method is used to convert the raw response bytes received from a REST API into an InferResponse object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
res_bytes |
bytes
|
The raw response bytes received from the REST API. |
required |
json_length |
int
|
The length of the JSON part of the response. |
required |
Returns:
Name | Type | Description |
---|---|---|
InferResponse |
InferResponse
|
The constructed InferResponse object. |
Raises:
Type | Description |
---|---|
InvalidInput
|
If the response format is unrecognized or if necessary fields are missing in the response. |
InferenceError
|
if failed to set data for the output tensor. |
Source code in kserve/protocol/infer_type.py
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 |
|
from_grpc(response)
classmethod
¶
The class method to construct the InferResponse object from gRPC message type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
response |
ModelInferResponse
|
The GRPC response as ModelInferResponse object. |
required |
Source code in kserve/protocol/infer_type.py
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 |
|
from_rest(response)
classmethod
¶
The class method to construct the InferResponse object from REST message type.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
response |
Dict
|
The response as a dict. |
required |
Source code in kserve/protocol/infer_type.py
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 |
|
get_output_by_name(name)
¶
Find an output Tensor in the InferResponse that has the given name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str name of the output Tensor object |
required |
Source code in kserve/protocol/infer_type.py
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 |
|
to_grpc()
¶
Converts the InferResponse object to gRPC ModelInferResponse type.
Returns:
Type | Description |
---|---|
ModelInferResponse
|
The ModelInferResponse gRPC message. |
Source code in kserve/protocol/infer_type.py
1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 |
|
to_rest()
¶
Converts the InferResponse object to v2 REST InferResponse Dict or bytes. This method is used to convert the InferResponse object into a format that can be sent over a REST API.
Returns:
Type | Description |
---|---|
Tuple[Union[bytes, Dict], Optional[int]]
|
Tuple[Union[bytes, Dict], Optional[int]]: A tuple containing the InferResponse in bytes or Dict and the length of the JSON part of the response. If it is dict, then the json length will be None. |
Raises:
Type | Description |
---|---|
InvalidInput
|
If the output data is not a numpy array, bytes, or list. |
Source code in kserve/protocol/infer_type.py
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 |
|
RequestedOutput
¶
Source code in kserve/protocol/infer_type.py
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
|
binary_data: Optional[bool]
property
¶
Get the binary_data attribute from the parameters. This attribute indicates whether the data for the input should be in binary format.
Returns:
Type | Description |
---|---|
Optional[bool]
|
bool or None: True if the data should be in binary format, False otherwise. If the binary_data attribute is not set, returns None. |
name: str
property
¶
Get the name of the output.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The name of the output. |
parameters: Optional[Dict]
property
writable
¶
Get the additional parameters for the output.
Returns:
Type | Description |
---|---|
Optional[Dict]
|
Optional[Dict]: The additional parameters for the output. |
__init__(name, parameters=None)
¶
The RequestedOutput class represents an output that is requested as part of an inference request.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the output. |
required |
parameters |
Optional[Dict]
|
Additional parameters for the output. |
None
|
Source code in kserve/protocol/infer_type.py
408 409 410 411 412 413 414 415 416 417 |
|
deserialize_bytes_tensor(encoded_tensor)
¶
Deserializes an encoded bytes tensor into a numpy array of dtype of python objects
Parameters:
Name | Type | Description | Default |
---|---|---|---|
encoded_tensor |
bytes The encoded bytes tensor where each element has its length in first 4 bytes followed by the content |
required |
Source code in kserve/protocol/infer_type.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
|
serialize_byte_tensor(input_tensor)
¶
Serializes a bytes tensor into a flat numpy array of length prepended bytes. The numpy array should use dtype of np.object. For np.bytes, numpy will remove trailing zeros at the end of byte sequence and because of this it should be avoided.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_tensor |
np.array The bytes tensor to serialize. |
required |
Source code in kserve/protocol/infer_type.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
|
to_grpc_parameters(parameters)
¶
Converts REST parameters to GRPC InferParameter objects
:param parameters: parameters to be converted. :return: converted parameters as Dict[str, InferParameter] :raises InvalidInput: if the parameter type is not supported.
Source code in kserve/protocol/infer_type.py
1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 |
|
to_http_parameters(parameters)
¶
Converts GRPC InferParameter parameters to REST parameters
:param parameters: parameters to be converted. :return: converted parameters as Dict[str, Union[str, bool, int]]
Source code in kserve/protocol/infer_type.py
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 |
|