base
ModelManager
¶
Model managers keep track of a dictionary of Model objects and is responsible for passing requests to the right model using the infer method.
Source code in inference/core/managers/base.py
26 27 28 29 30 31 32 33 34 35 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 84 85 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 111 112 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 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 |
|
__contains__(model_id)
¶
Checks if the model is contained in the manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
Whether the model is in the manager. |
Source code in inference/core/managers/base.py
352 353 354 355 356 357 358 359 360 361 |
|
__getitem__(key)
¶
Retrieve a model from the manager by key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
The identifier of the model. |
required |
Returns:
Name | Type | Description |
---|---|---|
Model |
Model
|
The model corresponding to the key. |
Source code in inference/core/managers/base.py
363 364 365 366 367 368 369 370 371 372 373 |
|
__len__()
¶
Retrieve the number of models in the manager.
Returns:
Name | Type | Description |
---|---|---|
int |
int
|
The number of models in the manager. |
Source code in inference/core/managers/base.py
375 376 377 378 379 380 381 |
|
add_model(model_id, api_key, model_id_alias=None)
¶
Adds a new model to the manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
model
|
Model
|
The model instance. |
required |
Source code in inference/core/managers/base.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 |
|
check_for_model(model_id)
¶
Checks whether the model with the given ID is in the manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
Raises:
Type | Description |
---|---|
InferenceModelNotFound
|
If the model is not found in the manager. |
Source code in inference/core/managers/base.py
68 69 70 71 72 73 74 75 76 77 78 |
|
clear()
¶
Removes all models from the manager.
Source code in inference/core/managers/base.py
347 348 349 350 |
|
get_class_names(model_id)
¶
Retrieves the class names for a given model.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
Returns:
Type | Description |
---|---|
List[str]: The class names of the model. |
Source code in inference/core/managers/base.py
307 308 309 310 311 312 313 314 315 316 317 |
|
get_task_type(model_id, api_key=None)
¶
Retrieves the task type for a given model.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The task type of the model. |
Source code in inference/core/managers/base.py
319 320 321 322 323 324 325 326 327 328 329 |
|
infer_from_request(model_id, request, **kwargs)
async
¶
Runs inference on the specified model with the given request.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
request
|
InferenceRequest
|
The request to process. |
required |
Returns:
Name | Type | Description |
---|---|---|
InferenceResponse |
InferenceResponse
|
The response from the inference. |
Source code in inference/core/managers/base.py
80 81 82 83 84 85 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 111 112 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 |
|
infer_from_request_sync(model_id, request, **kwargs)
¶
Runs inference on the specified model with the given request.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
request
|
InferenceRequest
|
The request to process. |
required |
Returns:
Name | Type | Description |
---|---|---|
InferenceResponse |
InferenceResponse
|
The response from the inference. |
Source code in inference/core/managers/base.py
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 |
|
init_pingback()
¶
Initializes pingback mechanism.
Source code in inference/core/managers/base.py
34 35 36 37 38 39 40 |
|
keys()
¶
Retrieve the keys (model identifiers) from the manager.
Returns:
Type | Description |
---|---|
List[str]: The keys of the models in the manager. |
Source code in inference/core/managers/base.py
383 384 385 386 387 388 389 |
|
make_response(model_id, predictions, *args, **kwargs)
¶
Creates a response object from the model's predictions.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
predictions
|
List[List[float]]
|
The model's predictions. |
required |
Returns:
Name | Type | Description |
---|---|---|
InferenceResponse |
InferenceResponse
|
The created response object. |
Source code in inference/core/managers/base.py
238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
|
models()
¶
Retrieve the models dictionary from the manager.
Returns:
Type | Description |
---|---|
Dict[str, Model]
|
Dict[str, Model]: The keys of the models in the manager. |
Source code in inference/core/managers/base.py
391 392 393 394 395 396 397 |
|
postprocess(model_id, predictions, preprocess_return_metadata, *args, **kwargs)
¶
Processes the model's predictions after inference.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
predictions
|
ndarray
|
The model's predictions. |
required |
Returns:
Type | Description |
---|---|
List[List[float]]
|
List[List[float]]: The post-processed predictions. |
Source code in inference/core/managers/base.py
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
|
predict(model_id, *args, **kwargs)
¶
Runs prediction on the specified model.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
Returns:
Type | Description |
---|---|
Tuple[ndarray, ...]
|
np.ndarray: The predictions from the model. |
Source code in inference/core/managers/base.py
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
|
preprocess(model_id, request)
¶
Preprocesses the request before inference.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
request
|
InferenceRequest
|
The request to preprocess. |
required |
Returns:
Type | Description |
---|---|
Tuple[ndarray, PreprocessReturnMetadata]
|
Tuple[np.ndarray, List[Tuple[int, int]]]: The preprocessed data. |
Source code in inference/core/managers/base.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
|
remove(model_id)
¶
Removes a model from the manager.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_id
|
str
|
The identifier of the model. |
required |
Source code in inference/core/managers/base.py
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
|