Python API Reference¶
Auto-generated API documentation for all Python modules in the python/modules/ package.
modules.model¶
The main high-level module for running RF-DETR inference.
Detection
dataclass
¶
RFDETRModel
¶
High-level class for RF-DETR model inference.
Source code in python/modules/model.py
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 | |
__init__(model_path, device='gpu')
¶
Initialize the RF-DETR model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_path
|
str
|
Path to the ONNX model file. |
required |
device
|
str
|
Device preference ("gpu" or "cpu"). |
'gpu'
|
Source code in python/modules/model.py
predict(image, confidence_threshold=DEFAULT_CONFIDENCE_THRESHOLD, max_number_boxes=DEFAULT_MAX_NUMBER_BOXES)
¶
Predict bounding boxes and masks for a single image.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
image
|
Union[ndarray, Image]
|
Input image (OpenCV format BGR or PIL Image). |
required |
confidence_threshold
|
float
|
Confidence threshold for filtering boxes. |
DEFAULT_CONFIDENCE_THRESHOLD
|
max_number_boxes
|
int
|
Maximum number of boxes to return. |
DEFAULT_MAX_NUMBER_BOXES
|
Returns:
| Type | Description |
|---|---|
tuple[list[Detection], dict[str, float]]
|
A tuple of (detections, timings). |
Source code in python/modules/model.py
save_detections(image, detections, save_image_path)
¶
Draw bounding boxes, masks and class labels on the original image and save it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
image
|
ndarray
|
Original image (BGR). |
required |
detections
|
list[Detection]
|
List of Detection objects. |
required |
save_image_path
|
str
|
Path to save the result. |
required |
Source code in python/modules/model.py
modules.onnx_runtime¶
Low-level ONNX Runtime session wrapper.
OnnxRuntimeSession
¶
Wrapper class for ONNX Runtime session.
Source code in python/modules/onnx_runtime.py
4 5 6 7 8 9 10 11 12 13 14 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 | |
__init__(model_path, device='gpu')
¶
Initialize the ONNX Runtime session with the best available provider for the chosen device.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_path
|
str
|
Path to the ONNX model file. |
required |
device
|
str
|
Device preference ("gpu" or "cpu"). |
'gpu'
|
Source code in python/modules/onnx_runtime.py
run(input_data)
¶
Run inference with the provided input data, casting to the model's expected dtype.
Source code in python/modules/onnx_runtime.py
get_input_shape()
¶
get_input_name()
¶
modules.utils¶
Utility functions for image loading and coordinate conversions.
utils
¶
open_image(path)
¶
Open an image from a local path or a URL.
Source code in python/modules/utils.py
sigmoid(x)
¶
box_cxcywh_to_xywh(x)
¶
Convert boxes from center x, y, width, height (cxcywh) to x_left, y_top, width, height (xywh).
Source code in python/modules/utils.py
box_cxcywh_to_xyxyn(x)
¶
Convert boxes from center x, y, width, height (cxcywh) to min/max format (xyxyn).
Source code in python/modules/utils.py
Data Structures¶
Detection¶
A dataclass representing a single detection result:
| Field | Type | Description |
|---|---|---|
score |
float |
Confidence score in [0, 1] |
label |
int |
Predicted class index |
normalized_box |
np.ndarray |
Bounding box [x, y, w, h] normalized to [0, 1] |
unnormalized_box |
np.ndarray |
Bounding box [x, y, w, h] in pixels |
mask |
np.ndarray \| None |
Binary segmentation mask (H, W), or None for detection-only models |
Timings Dictionary¶
predict() returns a dict[str, float] with timing in milliseconds:
| Key | Description |
|---|---|
"preprocess" |
Image resize + normalize + tensor creation |
"ort_run" |
ONNX Runtime session execution |
"postprocess" |
Score filtering, box decoding, mask resize |
"total" |
End-to-end wall time including I/O |
Constants¶
| Constant | Value | Description |
|---|---|---|
DEFAULT_CONFIDENCE_THRESHOLD |
0.5 |
Default score cutoff |
DEFAULT_MAX_NUMBER_BOXES |
300 |
Max detections returned |