predictors
sleap_nn.export.predictors
¶
Predictors for exported models.
Modules:
| Name | Description |
|---|---|
base |
Predictor base class for exported models. |
onnx |
ONNX Runtime predictor. |
tensorrt |
TensorRT predictor for exported models. |
Classes:
| Name | Description |
|---|---|
ExportPredictor |
Base interface for exported model inference. |
ONNXPredictor |
ONNX Runtime inference with provider selection. |
TensorRTPredictor |
TensorRT inference for exported models. |
Functions:
| Name | Description |
|---|---|
detect_runtime |
Auto-detect runtime from file extension or folder contents. |
load_exported_model |
Load an exported model and return a predictor instance. |
ExportPredictor
¶
Bases: ABC
Base interface for exported model inference.
Methods:
| Name | Description |
|---|---|
benchmark |
Benchmark inference latency and throughput. |
predict |
Run inference on a batch of images. |
Source code in sleap_nn/export/predictors/base.py
benchmark(image, n_warmup=50, n_runs=200)
abstractmethod
¶
ONNXPredictor
¶
Bases: ExportPredictor
ONNX Runtime inference with provider selection.
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize ONNX predictor with execution providers. |
benchmark |
Benchmark inference latency and throughput. |
predict |
Run inference on a batch of images. |
Source code in sleap_nn/export/predictors/onnx.py
__init__(model_path, device='auto', providers=None)
¶
Initialize ONNX predictor with execution providers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_path
|
str
|
Path to the ONNX model file. |
required |
device
|
str
|
Device for inference ("auto", "cpu", or "cuda"). |
'auto'
|
providers
|
Optional[Iterable[str]]
|
ONNX Runtime execution providers. Auto-selected if None. |
None
|
Source code in sleap_nn/export/predictors/onnx.py
benchmark(image, n_warmup=50, n_runs=200)
¶
Benchmark inference latency and throughput.
Source code in sleap_nn/export/predictors/onnx.py
predict(image)
¶
Run inference on a batch of images.
Source code in sleap_nn/export/predictors/onnx.py
TensorRTPredictor
¶
Bases: ExportPredictor
TensorRT inference for exported models.
This predictor loads a native TensorRT engine file (.trt) and provides inference capabilities using CUDA for high-throughput predictions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
engine_path
|
str | Path
|
Path to the TensorRT engine file (.trt). |
required |
device
|
str
|
Device to run inference on (only "cuda" supported for TRT). |
'cuda'
|
Example
predictor = TensorRTPredictor("model.trt") outputs = predictor.predict(images) # uint8 [B, C, H, W]
Methods:
| Name | Description |
|---|---|
__init__ |
Initialize TensorRT predictor with a serialized engine. |
benchmark |
Benchmark inference performance. |
predict |
Run TensorRT inference. |
Source code in sleap_nn/export/predictors/tensorrt.py
15 16 17 18 19 20 21 22 23 24 25 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 | |
__init__(engine_path, device='cuda')
¶
Initialize TensorRT predictor with a serialized engine.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
engine_path
|
str | Path
|
Path to the TensorRT engine file. |
required |
device
|
str
|
Device for inference ("cuda" or "auto"). TensorRT requires CUDA. |
'cuda'
|
Source code in sleap_nn/export/predictors/tensorrt.py
benchmark(image, n_warmup=50, n_runs=200)
¶
Benchmark inference performance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
image
|
ndarray
|
Input image(s) as numpy array [B, C, H, W]. |
required |
n_warmup
|
int
|
Number of warmup runs (not timed). |
50
|
n_runs
|
int
|
Number of timed runs. |
200
|
Returns:
| Type | Description |
|---|---|
Dict[str, float]
|
Dict with timing statistics: - mean_ms: Mean inference time in milliseconds - std_ms: Standard deviation of inference time - min_ms: Minimum inference time - max_ms: Maximum inference time - fps: Frames per second (based on mean time and batch size) |
Source code in sleap_nn/export/predictors/tensorrt.py
predict(image)
¶
Run TensorRT inference.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
image
|
ndarray
|
Input image(s) as numpy array [B, C, H, W] with uint8 dtype. |
required |
Returns:
| Type | Description |
|---|---|
Dict[str, ndarray]
|
Dict mapping output names to numpy arrays. |
Source code in sleap_nn/export/predictors/tensorrt.py
detect_runtime(model_path)
¶
Auto-detect runtime from file extension or folder contents.
Source code in sleap_nn/export/predictors/__init__.py
load_exported_model(model_path, runtime='auto', device='auto', **kwargs)
¶
Load an exported model and return a predictor instance.